docs: standardise readmes

Author: joshua-mo-143

actix-web/README.md

@@ -1,4 +1,4 @@
-# Actix Web with shuttle
+# Actix Web with Shuttle
 
 Normally one would configure an application with [Actix Web](https://docs.rs/actix-web/latest/actix_web/index.html) using the [App](https://docs.rs/actix-web/latest/actix_web/struct.App.html) struct. However, shuttle needs to move the users configuration across threads to start the server on our backend, and the `App` struct is `!Send` and `!Sync`.
 

actix-web/clerk/README.md

@@ -1,4 +1,4 @@
-# Using Clerk auth with a Rust Actix web backend
+# Actix Web with Clerk auth
 
 This template uses Actix-web and the clerk-rs crate for providing authentication from Clerk in the backend.
 

actix-web/cookie-authentication/README.md

@@ -1,7 +1,9 @@
-# Cookie authentication with actix-session
+# Actix Web Cookie authentication with actix-session
 
 This template uses the [actix_identity](https://docs.rs/actix-identity) and [actix_session](https://docs.rs/actix-session) crates to manage user sessions.
 
+## How to use
+
 Running the project and visiting <http://localhost:8000> will show the currently logged in user.
 Visiting <http://localhost:8000/login> will log you in as `user1` (no authentication logic is in place).
 Visiting <http://localhost:8000/logout> will log you out again.

actix-web/hello-world/README.md

@@ -1,5 +1,7 @@
+# Actix Web Hello World
+
 A `Hello world!` example for using Actix Web with Shuttle.
 
-## Example usage
+## How to use this template
 
 Run the app and go to <http://localhost:8000>.

actix-web/postgres/README.md

@@ -1,8 +1,10 @@
-# Shuttle shared Postgres DB with Actix Web
+# Actix Web with Shuttle Shared DB (Postgres)
 
 This template shows how to connect a Postgres database and use it for a simple TODO list app.
 
-## Example usage
+## How to use this template:
+
+Run the project then run the following `curl` commands below:
 
 ```bash
 curl -X POST -H 'content-type: application/json' localhost:8000/todos --data '{"note":"My todo"}'

actix-web/static-files/README.md

@@ -1,4 +1,4 @@
-# Actix Web static files
+## Actix Web Static Files
 
 This template uses `actix_files` to serve the files in the `assets` directory.
 

actix-web/websocket-actorless/README.md

@@ -1,7 +1,7 @@
-# Actix Web actorless websockets
+# Actix Web Actorless Websockets
 
 This template shows how to use actorless websockets to build an API monitoring service and a simple chat app.
 
-## Example usage
+## How to use this template
 
 Run the app and go to <http://localhost:8000>.

axum/hello-world/README.md

@@ -1,5 +1,7 @@
+# Axum Hello World
+
 A `Hello world!` example for using Axum with Shuttle.
 
-## Example usage
+## How to use this template
 
 Run the app and go to <http://localhost:8000>.

axum/htmx-crud/README.md

@@ -1,9 +1,9 @@
-# Axum + htmx
+# Axum with HTMx
 
 This is an example of how you can use Shuttle with Axum, Askama and htmx to create a frontend that's easily extendable and requires zero framework knowledge, while being able to easily inject variables from the backend into the frontend.
 
 The app is a TODO list with a main page and an event stream page.
 
-## Usage
+## How to use this template
 
 Run the app and go to <http://localhost:8000> to add and remove TODOs from the list.

axum/jwt-authentication/README.md

@@ -1,3 +1,7 @@
-# JWT authentication in Axum
+# Axum JWT authentication
 
 This template uses the `jsonwebtoken` crate to encode and decode claims in a JWT, which clients use in the Authorization HTTP header to access protected resources (endpoints).
+
+## Example usage
+
+Run the app and go to <http://localhost:8000>.

axum/metadata/README.md

@@ -1,5 +1,7 @@
+# Axum with Shuttle metadata
+
 An example that showcases Shuttle metadata at the base route using Axum.
 
-## Example usage
+## How to use this template
 
 Run the app and go to <http://localhost:8000>.

axum/oauth2/README.md

@@ -1,8 +1,8 @@
-# Google OAuth in Axum
+# Axum with Google OAuth
 
 This template is an example of how you can implement Google OAuth using the Axum web framework in Rust.
 
-## Prerequisites
+## How to use this template
 
 Make sure you set up your Google OAuth, which you can find a link to set up [here.](https://console.cloud.google.com/apis/dashboard)
 

axum/openai/README.md

@@ -1,5 +1,9 @@
+# Axum with OpenAI
+
 A simple endpoint that sends a chat message to ChatGPT and returns the response.
 
+## How to use this template
+
 Set your OpenAI API key in `Secrets.toml`, then try it on a local run with:
 
 ```sh

axum/postgres/README.md

@@ -1,8 +1,10 @@
-# Shuttle shared Postgres DB with Axum
+# Axum with Shuttle Shared DB (Postgres)
 
 This template shows how to connect a Postgres database and use it for a simple TODO list app.
 
-## Example usage
+## How to use this template
+
+Run the project then try the following `curl` commands:
 
 ```bash
 curl -X POST -H 'content-type: application/json' localhost:8000/todos --data '{"note":"My todo"}'

axum/qdrant/README.md

@@ -1,8 +1,8 @@
-# Connect to a Qdrant Cloud DB from Shuttle
+# Axum with Qdrant on Shuttle
 
 This example shows how to use `shuttle-qdrant` to connect to a Qdrant vector database from Shuttle.
 
-## Prerequisites
+## How to use this template
 
 Go to [Qdrant](https://qdrant.tech/) and start a database.
 Paste the URL and API key in the Secrets.toml file.

axum/static-files/README.md

@@ -1,5 +1,9 @@
-# Serving Static Assets with Axum
+# Axum with Static Assets
 
 This example shows how to serve static assets using [axum](https://github.com/tokio-rs/axum) and Shuttle.
 
 This example is inspired by the static-file-server example from the axum repo, to see more ways to do this check out the [original](https://github.com/tokio-rs/axum/blob/main/examples/static-file-server/src/main.rs).
+
+## Example usage
+
+Run the project and visit <http://localhost:8000>.

axum/turso/README.md

@@ -1,6 +1,8 @@
+# Axum with Turso
+
 An example that showcases using Turso with Axum and Shuttle.
 
-## Example usage
+## How to use this template
 
 Set your `TURSO_DB_TOKEN` in Secrets.toml and Turso database in `src/main.rs` in the annotation.
 

axum/websocket/README.md

@@ -1,5 +1,7 @@
+# Axum with Websockets
+
 This template shows how to use websockets with Axum in a Shuttle project.
 
-## Example usage
+## How to use this template
 
 Run the project and visit <http://localhost:8000> to try it out.

bevy/hello-world/README.md

@@ -1,6 +1,8 @@
+# Bevy on Shuttle (with Axum)
+
 Example of how you can compile Bevy to WASM and run it on Shuttle.
 
-## Instructions
+## How to use this template
 
 Make sure you have `wasm-bindgen-cli` and the rustup `wasm32-unknown-unknown` compilation target added. If you don't, you can get them by running the following:
 ```bash

custom-resource/pdo/README.md

@@ -1,5 +1,7 @@
+# Custom Shuttle Resource
+
 This template shows how to create your own custom Shuttle resource in a Shuttle project, using Axum for the `main.rs` file to set up the router.
 
-## Example usage
+## How to use this template
 
 Run the project and visit <http://localhost:8000>.

custom-service/none/README.md

@@ -1,6 +1,8 @@
+# Shuttle Custom Service
+
 This template shows how to create your own custom Shuttle service that can run anything HTTP-based.
 
-## Example usage
+## How to use this template
 
 Set up whatever you want to do in the `bind()` function, then visit <http://localhost:8000> (or your relevant routes) to try it out.
 

fullstack-templates/saas/README.md

@@ -21,7 +21,7 @@ users will be able to view their customers, sales records as well as some analyt
 - Typescript.
 - [cargo-shuttle](https://www.shuttle.rs)
 
-## Instructions for Usage
+## How to use this template
 
 - Initialize the template with:
 

loco/hello-world/README.md

@@ -14,10 +14,6 @@ Welcome to the [Loco](https://loco.rs) Hello World Shuttle Template, designed wi
 
 So see more Loco features, check out our [documentation website](https://loco.rs/docs/getting-started/tour/).
 
-## Quick Start
+## How to use this template
 
-To launch your app, simply use the following command:
-
-```sh
-shuttle run
-```
+Run the project and visit <http://localhost:8000>.

other/feature-flags/README.md

@@ -1,5 +1,7 @@
+# Cargo Feature Flags with Shuttle
+
 An example that showcases how to use feature flags with Shuttle (see `Cargo.toml`).
 
-## Example usage
+## How to use this template
 
 Run the project and visit <http://localhost:8000>.

other/standalone-binary/README.md

@@ -8,3 +8,9 @@ All startup logic is placed in the binary source files, while the implementation
 - `src/bin/standalone.rs` is without Shuttle, run with `cargo run --bin standalone` (you can change the name)
 
 This example shows how to use separate logic for getting secrets (Shuttle secrets vs homemade solution), but the same approach can be applied to other resources that are initiated by Shuttle's main function.
+
+## How to use this template
+
+Run the project and visit <http://localhost:8000>.
+
+You can use `cargo run --bin standalone` to run the non-Shuttle binary.

poem/hello-world/README.md

@@ -1,5 +1,7 @@
-An example that showcases using the `poem` web service framework with Shuttle.
+# Poem Hello World
 
-## Example usage
+An example that showcases using the `poem` web service framework with shuttle.
+
+## How to use this template
 
 Run the project and visit <http://localhost:8000>.

poise/hello-world/README.md

@@ -2,6 +2,8 @@
 
 In this example we will deploy a Poise/Serenity bot with Shuttle that responds to the `/hello` command with `world!`. To run this bot we need a valid Discord Token. To get started log in to the [Discord developer portal](https://discord.com/developers/applications).
 
+## How to use this template
+
 1. Click the New Application button, name your application and click Create.
 2. Navigate to the Bot tab in the lefthand menu, and add a new bot.
 3. On the bot page click the Reset Token button to reveal your token. Put this token in your `Secrets.toml`. It's very important that you don't reveal your token to anyone, as it can be abused. Create a `.gitignore` file to omit your `Secrets.toml` from version control.

rocket/dyn-templates/README.md

@@ -1,5 +1,9 @@
-# Rendering Handlebars dynamic templates with Rocket
+# Rocket with dynamic templates using Handlebars
 
 This example shows how to render templated content using Handlebars templates from [rocket](https://github.com/SergioBenitez/Rocket/) and shuttle.
 
 This example is inspired by templating example from the rocket repo, to see more ways to do this checkout the [original](https://github.com/SergioBenitez/Rocket/tree/master/examples/templating).
+
+## How to use
+
+Run the project and visit <http://localhost:8000>.

rocket/hello-world/README.md

@@ -1,5 +1,7 @@
+# Rocket Hello World
+
 An example that showcases using the `rocket` web service framework with Shuttle.
 
-## Example usage
+## How to use this template
 
 Run the project and visit <http://localhost:8000>.

rocket/jwt-authentication/README.md

@@ -1,4 +1,4 @@
-# Issue and verify JWT for authentication
+# Rocket with JWT authentication
 
 This example shows how to use [Rocket request guards](https://rocket.rs/v0.5-rc/guide/requests/#request-guards) for authentication with [JSON Web Tokens](https://jwt.io/) (JWT for short).
 The idea is that all requests authenticate first at <https://authentication-rocket-app.shuttleapp.rs/login> to get a JWT.
@@ -35,7 +35,7 @@ shuttle deploy
 
 Now make a note of the `Host` for the deploy to use in the examples below. Or just use `authentication-rocket-app.shuttleapp.rs` as the host below.
 
-### Seeing it in action
+## How to use this template
 
 First, we should be able to access the public endpoint without any authentication using:
 

rocket/opendal-memory/README.md

@@ -8,3 +8,12 @@ The project consists of the following files
 
 - `Shuttle.toml` contains the name of the app
 - `src/main.rs` is where all the magic happens - it creates a Shuttle service with two endpoints: one for adding new data and one for retrieving it back.
+
+## How to use this template
+
+Run the project, then try out the following `curl` command:
+
+```bash
+curl -X POST -H 'content-type: application/json' localhost:8000/todo --data '{"note":"My todo"}'
+# {"id":1,"note":"My todo"}
+```

rocket/postgres/README.md

@@ -1,8 +1,10 @@
-# Shuttle shared Postgres DB with Rocket
+# Rocket with Shuttle Shared DB (Postgres)
 
 This template shows how to connect a Postgres database and use it for a simple TODO list app.
 
-## Example usage
+## How to use this template
+
+Run the project then try the following `curl` commands:
 
 ```bash
 curl -X POST -H 'content-type: application/json' localhost:8000/todo --data '{"note":"My todo"}'

rocket/secrets/README.md

@@ -1,5 +1,12 @@
-## How to use
+## Using Shuttle Secrets with Rocket
+
+This example shows how to use secrets using [rocket](https://github.com/rwf2/rocket) and Shuttle.
+
 The secrets resource requires a `Secrets.toml` file to be present in your crate. Each like in this file
 should be a key-value pair that you can access using `SecretStore::get(&self, key)`.
 
+## How to use
+
 Rename `Secrets.toml.example` to `Secrets.toml` to use this example.
+
+Once done, run the example and visit <http://localhost:8000>.

rocket/static-files/README.md

@@ -1,3 +1,7 @@
-# Serving Static Assets with Rocket
+## Serving Static Assets with Rocket
 
 This example shows how to serve static assets using [rocket](https://github.com/rwf2/rocket) and Shuttle.
+
+## Example usage
+
+Run the project and visit <http://localhost:8000>.

rocket/url-shortener/README.md

@@ -1,8 +1,8 @@
-# Url Shortener
+# Rocket URL Shortener
 
 A URL shortener that you can use from your terminal - built with shuttle, rocket and postgres/sqlx.
 
-## How to use it
+## How to use this template
 
 You can use this URL shortener directly from your terminal. Just copy and paste this command to your terminal and replace `<URL>` with the URL that you want to shorten
 

rocket/workspace/README.md

@@ -1,5 +1,6 @@
+# Rocket with Cargo Workspaces
 This example shows how to use a Cargo workspace with Shuttle using the `rocket` web service frameowrk.
 
-## Example usage
+## How to use this template
 
 Run the project and visit <http://localhost:8000>.

salvo/hello-world/README.md

@@ -1,5 +1,7 @@
+# Salvo Hello World
+
 An example that showcases using the `salvo` web service framework with Shuttle.
 
-## Example usage
+## How to use this template
 
 Run the project and visit <http://localhost:8000>.

salvo/image-rescaler/README.md

@@ -1,5 +1,7 @@
-# Image rescaler
+# Salvo image rescaler
 
 This is a simple example showing how to use path parameters in Salvo and the `image` crate to load and manipulate an image.
 
+## How to use this template
+
 Running the project and going to `/400/400` returns the Shuttle logo image but rescaled to 400 x 400 pixels.

serenity/hello-world/README.md

@@ -2,6 +2,8 @@
 
 In this example we will deploy a Serenity bot with Shuttle that responds to the `!hello` command with `world!`. To run this bot we need a valid Discord Token. To get started log in to the [Discord developer portal](https://discord.com/developers/applications).
 
+## How to use this template
+
 1. Click the New Application button, name your application and click Create.
 2. Navigate to the Bot tab in the lefthand menu, and add a new bot.
 3. On the bot page click the Reset Token button to reveal your token. Put this token in your `Secrets.toml`. It's very important that you don't reveal your token to anyone, as it can be abused. Create a `.gitignore` file to omit your `Secrets.toml` from version control.