From 9a987532d58da8e626d89f60101d9ebb22fa077c Mon Sep 17 00:00:00 2001 From: Jonathan Johnson Date: Sat, 11 May 2024 19:41:49 -0700 Subject: [PATCH] Adding "screenshot" to readme --- .crate-docs.md | 5 ++++- .rustme/docs.md | 5 ++++- README.md | 5 ++++- 3 files changed, 12 insertions(+), 3 deletions(-) diff --git a/.crate-docs.md b/.crate-docs.md index 3f890e6..2f5c6c4 100644 --- a/.crate-docs.md +++ b/.crate-docs.md @@ -54,7 +54,10 @@ Here are some ways to learn more about Cushy: - Explore the [examples directory][examples]. Nearly every feature in Cushy was initially tested by creating an example. -- Browse the [user's guide][guide]. +- Browse the [user's guide][guide]. The user guide is a work in progress, but + features CI-generated screenshots and animations for its examples: + + ![Hello, World User Guide Example](https://cushy.rs/main/guide/examples/intro.png) - Ask questions [in Discussions][discussions] or [on Discord][discord]. ## Project Status diff --git a/.rustme/docs.md b/.rustme/docs.md index 35db32f..4fb2a5e 100644 --- a/.rustme/docs.md +++ b/.rustme/docs.md @@ -41,7 +41,10 @@ Here are some ways to learn more about Cushy: - Explore the [examples directory][examples]. Nearly every feature in Cushy was initially tested by creating an example. -- Browse the [user's guide][guide]. +- Browse the [user's guide][guide]. The user guide is a work in progress, but + features CI-generated screenshots and animations for its examples: + + ![Hello, World User Guide Example](https://cushy.rs/main/guide/examples/intro.png) - Ask questions [in Discussions][discussions] or [on Discord][discord]. ## Project Status diff --git a/README.md b/README.md index 6c77949..dece86c 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,10 @@ Here are some ways to learn more about Cushy: - Explore the [examples directory][examples]. Nearly every feature in Cushy was initially tested by creating an example. -- Browse the [user's guide][guide]. +- Browse the [user's guide][guide]. The user guide is a work in progress, but + features CI-generated screenshots and animations for its examples: + + ![Hello, World User Guide Example](https://cushy.rs/main/guide/examples/intro.png) - Ask questions [in Discussions][discussions] or [on Discord][discord]. ## Project Status