Skip to content

Commit 5c59ae6

Browse files
committed
docs: ✏️ fixed some typos and clarified things in readmes
1 parent 3d70be1 commit 5c59ae6

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

README.md

+13-12
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
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!
66

7-
- ✨ Supports static generation (serving only static resources)
8-
- ✨ Supports server-side rendering (serving dynamic resources)
9-
- ✨ Supports revalidation after time and/or with custom logic (updating rendered pages)
10-
- ✨ Supports incremental regeneration (build on demand)
11-
- ✨ Open build matrix (use any rendering strategy with anything else, mostly)
12-
- ✨ CLI harness that lets you build apps with ease and confidence
7+
- ✨ Supports static generation (serving only static resources)
8+
- ✨ Supports server-side rendering (serving dynamic resources)
9+
- ✨ Supports revalidation after time and/or with custom logic (updating rendered pages)
10+
- ✨ Supports incremental regeneration (build on demand)
11+
- ✨ Open build matrix (use any rendering strategy with anything else, mostly)
12+
- ✨ CLI harness that lets you build apps with ease and confidence
1313

1414
## How to use
1515

@@ -29,17 +29,18 @@ There is a sore lack of Rust frameworks for frontend development that support mo
2929

3030
These tasks still need to be done before Perseus can be pushed to v1.0.0.
3131

32-
* [x] Create a custom CLI as a harness for apps without riediculous amounts of configuration needed
33-
- [ ] Support custom template hierarchies
34-
- [ ] Support i18n out of the box
35-
- [ ] (Maybe) Implement custom router
36-
- [ ] Pre-built integrations for Actix Web (done) and AWS Lambda (todo)
32+
- [x] Create a custom CLI as a harness for apps without ridiculous amounts of configuration needed
33+
34+
* [ ] Support custom template hierarchies
35+
* [ ] Support i18n out of the box
36+
* [ ] (Maybe) Implement custom router
37+
* [ ] Pre-built integrations for Actix Web (done) and AWS Lambda (todo)
3738

3839
### Beyond
3940

4041
These tasks will be done after Perseus is stable.
4142

42-
- [ ] Integrations for other platforms
43+
- [ ] Integrations for other platforms
4344

4445
## Contributing
4546

examples/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ members = [
1616
]
1717
```
1818

19-
All examples should have both an `app` and a `server` directory.
19+
All (non-CLI) examples should have both an `app` and a `server` directory.
2020

2121
- Showcase -- an app that demonstrates all the different features of Perseus, including SSR, SSG, and ISR (this example is actively used for testing)
2222
- Basic -- a simple app that uses the Perseus CLI (symlinks to CLI example)

0 commit comments

Comments
 (0)