Skip to content

Commit bf931e4

Browse files
committed
docs: 📝 updated docs for v0.1.0
1 parent 23fd0a6 commit bf931e4

File tree

3 files changed

+4
-14
lines changed

3 files changed

+4
-14
lines changed

README.md

+3-11
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
[Book][book][Crate Page][crate][API Documentation][docs][Contributing][contrib]
44

5-
> 🚧 Perseus is **nearly** ready for v0.1.0, but is still under construction! 🚧
6-
75
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!
86

97
- ✨ Supports static generation (serving only static resources)
@@ -14,7 +12,7 @@ Perseus is a blazingly fast frontend web development framework built in Rust wit
1412

1513
## How to use
1614

17-
Check out the docs [here](https://arctic-hen7.github.io/perseus) (WORK IN PROGRESS!) for how to use Perseus.
15+
Check out the docs [here](https://arctic-hen7.github.io/perseus) for how to use Perseus.
1816

1917
## Aim
2018

@@ -26,21 +24,15 @@ There is a sore lack of Rust frameworks for frontend development that support mo
2624

2725
## Roadmap
2826

29-
### Pre-beta
30-
31-
These tasks still need to be done before Perseus can be pushed to v0.1.0.
32-
33-
- [ ] Support providing request data to SSR renderers
34-
3527
### Pre-stable
3628

3729
These tasks still need to be done before Perseus can be pushed to v1.0.0.
3830

31+
* [x] Create a custom CLI as a harness for apps without riediculous amounts of configuration needed
3932
- [ ] Support custom template hierarchies
40-
- [ ] Create a custom CLI as a harness for apps without riediculous amounts of configuration needed
4133
- [ ] Support i18n out of the box
4234
- [ ] (Maybe) Implement custom router
43-
- [ ] Pre-built integrations for Actix Web and AWS Lambda
35+
- [ ] Pre-built integrations for Actix Web (done) and AWS Lambda (todo)
4436

4537
### Beyond
4638

docs/src/intro.md

-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
[Home][repo][Crate Page][crate][API Documentation][docs][Contributing][contrib]
44

5-
> 🚧 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! 🚧
6-
75
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!
86

97
[repo]: https://github.com/arctic-hen7/perseus

docs/src/templates.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ pub fn template_fn<G: GenericNode>() -> perseus::template::TemplateFn<G> {
2525
})
2626
}
2727

28-
pub fn get_page<G: GenericNode>() -> Template<G> {
28+
pub fn get_template<G: GenericNode>() -> Template<G> {
2929
Template::new("about").template(template_fn())
3030
}
3131
```

0 commit comments

Comments
 (0)