From bf931e4909b398f94b70ad37994497e1f9cab4ca Mon Sep 17 00:00:00 2001 From: arctic_hen7 Date: Fri, 3 Sep 2021 07:06:51 +1000 Subject: [PATCH] =?UTF-8?q?docs:=20=F0=9F=93=9D=20updated=20docs=20for=20v?= =?UTF-8?q?0.1.0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 14 +++----------- docs/src/intro.md | 2 -- docs/src/templates.md | 2 +- 3 files changed, 4 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 502a76f457..405713513d 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,6 @@ [Book][book] • [Crate Page][crate] • [API Documentation][docs] • [Contributing][contrib] -> 🚧 Perseus is **nearly** ready for v0.1.0, but is still under construction! 🚧 - Perseus is a blazingly fast frontend web development framework built in Rust with support for major rendering strategies, reactivity without a virtual DOM, and extreme customizability. It wraps the lower-level capabilities of [Sycamore](https://github.com/sycamore-rs/sycamore) and provides a NextJS-like API! - ✨ Supports static generation (serving only static resources) @@ -14,7 +12,7 @@ Perseus is a blazingly fast frontend web development framework built in Rust wit ## How to use -Check out the docs [here](https://arctic-hen7.github.io/perseus) (WORK IN PROGRESS!) for how to use Perseus. +Check out the docs [here](https://arctic-hen7.github.io/perseus) for how to use Perseus. ## Aim @@ -26,21 +24,15 @@ There is a sore lack of Rust frameworks for frontend development that support mo ## Roadmap -### Pre-beta - -These tasks still need to be done before Perseus can be pushed to v0.1.0. - -- [ ] Support providing request data to SSR renderers - ### Pre-stable These tasks still need to be done before Perseus can be pushed to v1.0.0. +* [x] Create a custom CLI as a harness for apps without riediculous amounts of configuration needed - [ ] Support custom template hierarchies -- [ ] Create a custom CLI as a harness for apps without riediculous amounts of configuration needed - [ ] Support i18n out of the box - [ ] (Maybe) Implement custom router -- [ ] Pre-built integrations for Actix Web and AWS Lambda +- [ ] Pre-built integrations for Actix Web (done) and AWS Lambda (todo) ### Beyond diff --git a/docs/src/intro.md b/docs/src/intro.md index b63de8d657..ce43f928e6 100644 --- a/docs/src/intro.md +++ b/docs/src/intro.md @@ -2,8 +2,6 @@ [Home][repo] • [Crate Page][crate] • [API Documentation][docs] • [Contributing][contrib] -> 🚧 This book is nearly complete, but Perseus is not yet in beta yet, so you can't install it as a library or use it yet! We're working on it, and it'll be ready very soon, we promise! 🚧 - Welcome to the Perseus documentation! Here, you'll find guides on how to use Perseus, as well as documentation for specific features and plenty of examples! [repo]: https://github.com/arctic-hen7/perseus diff --git a/docs/src/templates.md b/docs/src/templates.md index 1cd80d7f1f..5f722987a4 100644 --- a/docs/src/templates.md +++ b/docs/src/templates.md @@ -25,7 +25,7 @@ pub fn template_fn() -> perseus::template::TemplateFn { }) } -pub fn get_page() -> Template { +pub fn get_template() -> Template { Template::new("about").template(template_fn()) } ```