docs: give every template a README.md

actix-web/hello-world/README.md

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

axum/hello-world/README.md

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

axum/metadata/README.md

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

axum/turso/README.md

@@ -0,0 +1,11 @@
+An example that showcases using Turso with Axum and Shuttle.
+
+## Example usage
+
+Set your `TURSO_DB_TOKEN` in Secrets.toml and Turso database in `src/main.rs` in the annotation.
+
+Run the app, then try it out with the following `curl` command:
+
+```sh
+curl http://localhost:8000 -H 'content-type: application/json' --data '{"uid":"1","email":"foo@bar.xyz"}'
+```

axum/websocket/README.md

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

custom-resource/pdo/README.md

@@ -0,0 +1,5 @@
+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
+
+Run the project and visit <http://localhost:8000>.

custom-service/none/README.md

@@ -0,0 +1,7 @@
+This template shows how to create your own custom Shuttle service that can run anything HTTP-based.
+
+## Example usage
+
+Set up whatever you want to do in the `bind()` function, then visit <http://localhost:8000> (or your relevant routes) to try it out.
+
+Variables from resource annotations can be added to `MyService` struct to use them in the `bind()` function.

other/feature-flags/README.md

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

poem/hello-world/README.md

@@ -0,0 +1,5 @@
+An example that showcases using the `poem` web service framework with Shuttle.
+
+## Example usage
+
+Run the project and visit <http://localhost:8000>.

rocket/hello-world/README.md

@@ -0,0 +1,5 @@
+An example that showcases using the `rocket` web service framework with Shuttle.
+
+## Example usage
+
+Run the project and visit <http://localhost:8000>.

rocket/postgres/README.md

@@ -0,0 +1,13 @@
+# Shuttle shared Postgres DB with Rocket
+
+This template shows how to connect a Postgres database and use it for a simple TODO list app.
+
+## Example usage
+
+```bash
+curl -X POST -H 'content-type: application/json' localhost:8000/todo --data '{"note":"My todo"}'
+# {"id":1,"note":"My todo"}
+
+curl localhost:8000/todos/1
+# {"id":1,"note":"My todo"}
+```

rocket/static-files/README.md

@@ -0,0 +1,3 @@
+# Serving Static Assets with Rocket
+
+This example shows how to serve static assets using [axum](https://github.com/rwf2/rocket) and Shuttle.

rocket/workspace/README.md

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

salvo/hello-world/README.md

@@ -0,0 +1,5 @@
+An example that showcases using the `salvo` web service framework with Shuttle.
+
+## Example usage
+
+Run the project and visit <http://localhost:8000>.

shuttle-cron/README.md

@@ -0,0 +1,16 @@
+# `shuttle-cron`
+
+A service that prints out a log message at specified cron-style intervals.
+
+This example uses the `apalis` framework to be able to carry out cronjobs. A struct is defined that has some given data in it, and is stored in the Apalis monitor. We also implement a struct that holds a `chrono::DateTime<chrono::Utc>`, which `apalis` uses internally for cron job streaming.
+
+When the cron job is called, the data is grabbed from the `JobContext` and we then execute the job.
+
+The actual function to be ran itself is stored in `job_fn()` in the main function, as a function pointer.
+
+# Usage
+Run `shuttle run` to spin up the service locally.
+
+You can change the behavior of the cronjob by editing the `execute()` function for `CronjobData`.
+
+Note that the run method doesn't have to be an implementation method for `CronjobData` - you can write your own!

templates.toml

@@ -49,7 +49,7 @@ template = "axum"
 [starters.bevy-hello-world]
 title = "Bevy"
 description = "Data driven game engine that compiles to WASM"
-path = "bevy/hello-world"
+path = "bevy/hello-world/"
 use_cases = ["Web app", "Game"]
 tags = ["bevy", "axum"]
 

thruster/hello-world/README.md

@@ -0,0 +1,5 @@
+An example that showcases using the `thruster` web service framework with Shuttle.
+
+## Example usage
+
+Run the project and visit <http://localhost:8000>.

tide/hello-world/README.md

@@ -0,0 +1,5 @@
+An example that showcases using the `tide` web service framework with Shuttle.
+
+## Example usage
+
+Run the project and visit <http://localhost:8000>.

tower/hello-world/README.md

@@ -0,0 +1,5 @@
+An example that showcases using the `tower` web service framework (with `hyper`) with Shuttle.
+
+## Example usage
+
+Run the project and visit <http://localhost:8000>.

tracing/custom-tracing-subscriber/README.md

@@ -0,0 +1,10 @@
+An example that showcases using a custom `tracing-subscriber` with Shuttle.
+
+Notes:
+- `default-features` is disabled on `shuttle-runtime` crate to allow this to be possible
+
+## Example usage
+
+Run the project and visit <http://localhost:8000>.
+
+You can also additionally adjust the custom tracing subscriber as you want.

warp/hello-world/README.md

@@ -0,0 +1,5 @@
+An example that showcases using the `warp` web service framework (with `hyper`) with Shuttle.
+
+## Example usage
+
+Run the project and visit <http://localhost:8000>.