Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
levkk committed Oct 17, 2024
1 parent 8bd6b00 commit f14ad01
Showing 1 changed file with 2 additions and 12 deletions.
14 changes: 2 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

Rwf is a comprehensive framework for building web applications in Rust. Written using the classic MVC pattern (model-view-controller), Rwf comes standard with everything you need to easily build fast and secure web apps.

### Documentation
## Documentation

:blue_book: The documentation (work in progress) **[is available here](https://levkk.github.io/rwf/)**.

### Features overview
## Features overview

- :heavy_check_mark: [HTTP server](examples/quick-start)
- :heavy_check_mark: User-friendly [ORM](examples/orm) to build PostgreSQL queries easily
Expand Down Expand Up @@ -63,16 +63,6 @@ async fn main() {

See [examples](examples) for common use cases.

## Documentation

* [ORM & database migrations](examples/orm/README.md)
* [Dynamic templates](examples/dynamic-templates/README.md)
* [Authentication & sessions](examples/auth/README.md)
* [Middleware](examples/middleware/README.md)
* [Background jobs](examples/background-jobs/README.md)
* [Scheduled jobs](examples/scheduled-jobs/README.md)
* [REST Framework](examples/rest/README.md)

## :construction: Status :construction:

Rwf is in early development and not ready for production. Many features and documentation are incomplete. Contributions are welcome. Please see [CONTRIBUTING](CONTRIBUTING.md) for guidelines, [ARCHITECTURE](ARCHITECTURE.md) for a tour of the code, and [ROADMAP](ROADMAP.md) for a non-exhaustive list of desired features.

0 comments on commit f14ad01

Please sign in to comment.