diff --git a/README.md b/README.md index 21aa3f8..8a9e221 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # Examples for async-graphql +A git submodule that shows example async-graphql projects. + + ## Directory structure - [poem] Examples for `poem` @@ -9,3 +12,28 @@ - [rocket] Examples for `rocket` - [axum] Examples for `axum` - [federation] Examples for [Apollo Federation](https://www.apollographql.com/docs/federation/) + + +## Running Examples + +To run the examples, clone the top-level repo, [async-graphql](https://github.com/async-graphql/async-graphql) and then issue the following commands: + +```bash +git clone async-graphql/async-graphql +# in async-graphql repo, install needed dependencies +cargo build + +# update this repo as a git submodule +git submodule update +``` + +To run the example axum-starwars: +``` +# change into the example folder and run a relevant binary +cargo run --bin axum-starwars +``` + +To list all available binary targets: +``` +cargo run --bin +``` \ No newline at end of file