diff --git a/README.md b/README.md index 3e40ef17..db270f37 100644 --- a/README.md +++ b/README.md @@ -24,51 +24,34 @@ Some of its features are: - 🧬 Server Side Rendering - 🔥 Hot Module Reload -## 📖 Documentation +## Documentation The [documentation](https://tuono.dev/) is available on [tuono.dev](https://tuono.dev/). -## Introduction +## Installation -**NodeJs/Deno/Bun are the only runtimes that allow a React app to be full-stack right? (no)** +Available on MacOS, Linux and Windows. -Tuono is a full-stack React framework with the server side written in Rust. -Because of this, Tuono is extremely fast, and the requests are handled by a multithreaded Rust server. -React is still React - it is just superpowered. - -**Rust is a hard language, then writing server-side code is hard as well, right? (no again)** - -Tuono provides a collection of utilities to handle the server side code seamlessly with the React code. -Each server-side route is managed in a separate file alongside the React route. The routing is handled -by Tuono based on the files defined within the `./src/routes` directory. - -**How is Tuono different from Next.js?** - -The Tuono API tries to stick as much as possible to the Next.js one (or at least takes a huge inspiration -from it). The major difference is the backend system. While Next.js relies entirely on Node/Deno/Bun, -Tuono runs the server without any intermediary runtime. This enables impressive performance improvements -(check the benchmarks [here](https://github.com/tuono-labs/tuono-benchmarks)). +```sh +cargo install tuono +``` ## Getting started -Tuono is the CLI that provides all the needed commands to handle the full-stack project. -To download it is required [cargo](https://doc.rust-lang.org/cargo/), which is the [rust](https://www.rust-lang.org/) -package manager. +Create a new project with: -Then run `cargo install tuono`. +```sh +tuono new [PROJECT_NAME] +``` -To list all the available commands, run `tuono -h` +> You can optionally pass the --template (or -t) flag to directly start from a [template](https://github.com/tuono-labs/tuono/tree/main/examples) -To create a new project, run `tuono new [NAME]` (optionally, you can pass the `--template` (or `-t`) flag - check the -[examples](https://github.com/tuono-labs/tuono/tree/main/examples) folder). +Now just install the dependencies with you favourite JS package manager (i.e. `npm install`) and start the development environment -Then, to run the local development environment, install the JS dependencies (`npm install`) and run inside the project folder `tuono dev` - -Finally, when the project is ready to be deployed, just run `tuono build` to create the final React assets -and to set the server project in `production` mode. - -Now to execute it just run `cargo run --release`. +```sh +tuono dev +``` ## Contributing