Skip to content

Commit

Permalink
docs: 📝 cleaned up docs
Browse files Browse the repository at this point in the history
  • Loading branch information
arctic-hen7 committed Sep 21, 2021
1 parent c7d3ea2 commit b6a6b72
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@

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

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!
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)!

- Supports static generation (serving only static resources)
- Supports server-side rendering (serving dynamic resources)
- Supports revalidation after time and/or with custom logic (updating rendered pages)
- Supports incremental regeneration (build on demand)
- Open build matrix (use any rendering strategy with anything else, mostly)
- CLI harness that lets you build apps with ease and confidence
- Full i18n support out-of-the-box with [Fluent](https://projectfluent.org)
- 📕 Supports static generation (serving only static resources)
- 🗼 Supports server-side rendering (serving dynamic resources)
- 🔧 Supports revalidation after time and/or with custom logic (updating rendered pages)
- 🛠️ Supports incremental regeneration (build on demand)
- 🏭 Open build matrix (use any rendering strategy with anything else)
- 🖥️ CLI harness that lets you build apps with ease and confidence
- 🌐 Full i18n support out-of-the-box with [Fluent](https://projectfluent.org)

## Usage

Here's a taste of Perseus (see [the *tiny* example](https://github.com/arctic-hen7/perseus/tree/main/examples/tiny) for more):
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};
Expand Down Expand Up @@ -61,7 +61,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
* [x] Improve SEO and initial load performance
* [x] Improve SEO and initial load performance
* [ ] Support custom template hierarchies
* [ ] Pre-built integrations
- [x] Actix Web
Expand Down
2 changes: 1 addition & 1 deletion docs/next/src/what-is-perseus.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Perseus aims to be more convenient than any other Rust web framework by taking a
Basically, here's your workflow:

1. Create a new project.
2. Define your app in under 30 lines of code (coming down to 15 with v0.2.0!)
2. Define your app in around 12 lines of code and some listing.
3. Code your amazing app.
4. Run `perseus serve`.

Expand Down

0 comments on commit b6a6b72

Please sign in to comment.