aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFuwn <[email protected]>2023-04-19 22:37:31 +0000
committerFuwn <[email protected]>2023-04-19 22:37:31 +0000
commit7488876b28c608e3a702a880c6acf0864edd2da1 (patch)
treedfb524cf02ac4a73bd8e618f30ed92cac3815281 /README.md
parentdocs(examples): create a readme with details (diff)
downloadwindmark-7488876b28c608e3a702a880c6acf0864edd2da1.tar.xz
windmark-7488876b28c608e3a702a880c6acf0864edd2da1.zip
docs(readme): add information about examples
Diffstat (limited to 'README.md')
-rw-r--r--README.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/README.md b/README.md
index b7fecb0..509afa7 100644
--- a/README.md
+++ b/README.md
@@ -55,7 +55,8 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
## Examples
Examples can be found within the
-[`examples/`](https://github.com/gemrest/windmark/tree/main/examples) directory.
+[`examples/`](https://github.com/gemrest/windmark/tree/main/examples) directory
+along with a rundown of each of their purposes and useful facts.
An example of a fully featured Gemini capsule written using Windmark can be
found [here](https://github.com/gemrest/locus). This example Gemini capsule also