Skip to content

Commit

Permalink
docs: 📝 updated docs for v0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
arctic-hen7 committed Sep 2, 2021
1 parent 23fd0a6 commit bf931e4
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 14 deletions.
14 changes: 3 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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

Expand All @@ -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

Expand Down
2 changes: 0 additions & 2 deletions docs/src/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/src/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ pub fn template_fn<G: GenericNode>() -> perseus::template::TemplateFn<G> {
})
}

pub fn get_page<G: GenericNode>() -> Template<G> {
pub fn get_template<G: GenericNode>() -> Template<G> {
Template::new("about").template(template_fn())
}
```
Expand Down

0 comments on commit bf931e4

Please sign in to comment.