docs(examples): ✨ added new tiny example and updated readme with it

arctic-hen7 · arctic-hen7 · commit 2c2d06b3ee8c · 2021-09-20T11:57:54.000+10:00
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,3 +1,3 @@
 {
-    "conventionalCommits.scopes": ["i18n", "routing", "cli", "book"]
+    "conventionalCommits.scopes": ["i18n", "routing", "cli", "book", "examples"]
 }
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,14 +1,9 @@
 [workspace]
 members = [
-	"packages/perseus",
-	"packages/perseus-actix-web",
-	"packages/perseus-cli",
-    "examples/showcase",
-    "examples/cli",
+	"packages/*",
+    "examples/*",
     # We have the CLI subcrates as workspace members so we can actively develop on them
     # They also can't be a workspace until nested workspaces are supported
     "examples/cli/.perseus",
-    "examples/cli/.perseus/server",
-    "examples/basic",
-    "examples/i18n"
+    "examples/cli/.perseus/server"
 ]
diff --git a/README.md b/README.md
@@ -12,9 +12,31 @@ Perseus is a blazingly fast frontend web development framework built in Rust wit
 -   ✨ CLI harness that lets you build apps with ease and confidence
 -   ✨ Full i18n support out-of-the-box with [Fluent](https://projectfluent.org)
 
-## How to use
-
-Check out the docs [here](https://arctic-hen7.github.io/perseus) for how to use Perseus.
+## Usage
+
+Here's a taste of Perseus (see [the *tiny* example](https://github.com/arctic-hen7/perseus/tree/main/examples/tiny) for more):
+
+```rust
+use perseus::{define_app, ErrorPages, Template};
+use std::rc::Rc;
+use sycamore::template;
+define_app! {
+    templates: [
+        Template::<G>::new("index").template(Rc::new(|_| {
+            template! {
+                p { "Hello World!" }
+            }
+        }))
+    ],
+    error_pages: ErrorPages::new(Rc::new(|url, status, err, _| {
+        template! {
+            p { (format!("An error with HTTP code {} occurred at '{}': '{}'.", status, url, err)) }
+        }
+    }))
+}
+```
+
+Check out [the book](https://arctic-hen7.github.io/perseus) to learn how to turn that into your next app!
 
 ## Aim
 
@@ -35,7 +57,7 @@ These tasks still need to be done before Perseus can be pushed to v1.0.0.
 *   [x] Support i18n out of the box
 *   [x] Implement custom router
 *   [x] Allow direct modification of the document head
-*   [ ] Improve SEO and initial load performance
+* [x] Improve SEO and initial load performance
 *   [ ] Support custom template hierarchies
 *   [ ] Pre-built integrations
     -   [x] Actix Web
diff --git a/examples/tiny/.gitignore b/examples/tiny/.gitignore
@@ -0,0 +1,2 @@
+
+.perseus/
diff --git a/examples/tiny/Cargo.toml b/examples/tiny/Cargo.toml
@@ -0,0 +1,10 @@
+[package]
+name = "perseus-example-tiny"
+version = "0.1.4"
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+perseus = { path = "../../packages/perseus" }
+sycamore = "0.6"
diff --git a/examples/tiny/index.html b/examples/tiny/index.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="UTF-8" />
+        <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    </head>
+    <body>
+        <div id="root"></div>
+    </body>
+</html>
diff --git a/examples/tiny/src/lib.rs b/examples/tiny/src/lib.rs
@@ -0,0 +1,17 @@
+use perseus::{define_app, ErrorPages, Template};
+use std::rc::Rc;
+use sycamore::template;
+define_app! {
+    templates: [
+        Template::<G>::new("index").template(Rc::new(|_| {
+            template! {
+                p { "Hello World!" }
+            }
+        }))
+    ],
+    error_pages: ErrorPages::new(Rc::new(|url, status, err, _| {
+        template! {
+            p { (format!("An error with HTTP code {} occurred at '{}': '{}'.", status, url, err)) }
+        }
+    }))
+}

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- "conventionalCommits.scopes": ["i18n", "routing", "cli", "book"]`
	`2`	`+ "conventionalCommits.scopes": ["i18n", "routing", "cli", "book", "examples"]`
`3`	`3`	`}`