From 6efc93e6b3caa2c83e349856762b4caa79e8635c Mon Sep 17 00:00:00 2001 From: Sunli Date: Fri, 16 Oct 2020 09:21:16 +0800 Subject: [PATCH] Update readme --- README.md | 9 ++++++++- src/lib.rs | 9 ++++++++- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 618c7da0..45cdd7b8 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,14 @@ This crate uses `#![forbid(unsafe_code)]` to ensure everything is implemented in ## Examples -https://github.com/async-graphql/examples +All examples are in the [sub-repository](https://github.com/async-graphql/examples), located in the examples directory. + +**Run an example:** + +```shell +git submodule update # update the examples repo +cd examples && cargo run --bin [name] +``` ## Benchmark diff --git a/src/lib.rs b/src/lib.rs index fb583ca6..910a2ded 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -92,7 +92,14 @@ //! //! ## Examples //! -//! [https://github.com/async-graphql/examples](https://github.com/async-graphql/examples) +//! All examples are in the [sub-repository](https://github.com/async-graphql/examples), located in the examples directory. +//! +//! **Run an example:** +//! +//! ```shell +//! git submodule update # update the examples repo +//! cd examples && cargo run --bin [name] +//! ``` //! //! ## Benchmarks //!