From 7f3013e509b29040770a9579501dac50b4d20122 Mon Sep 17 00:00:00 2001
From: Michael Aaron Murphy <michael@mmurphy.dev>
Date: Wed, 13 Sep 2023 16:33:53 +0200
Subject: [PATCH] chore(readme): instructions for running examples

---
 README.md                       |  2 ++
 examples/README.md              | 24 ++++++++++++++++++++++++
 examples/open-dialog/Cargo.toml |  2 +-
 3 files changed, 27 insertions(+), 1 deletion(-)
 create mode 100644 examples/README.md

diff --git a/README.md b/README.md
index 381f3a79..efd09412 100644
--- a/README.md
+++ b/README.md
@@ -32,6 +32,8 @@ git reset --hard origin/master
 git submodule update --init --recursive
 ```
 
+The examples may then be run by their cargo project names, such as `just run cosmic-design-demo`.
+
 To create a new COSMIC project, use `cargo new {{name_of_project}}` to create a new
 project workspace, edit the `Cargo.toml` contained within, and add this to begin.
 
diff --git a/examples/README.md b/examples/README.md
new file mode 100644
index 00000000..beef9c99
--- /dev/null
+++ b/examples/README.md
@@ -0,0 +1,24 @@
+## `design-demo`
+
+Showcase of all widgets and their styled variations for the purpose of demonstrating and
+fine-tuning our design system.
+
+```sh
+just run cosmic-design demo
+```
+
+## `application`
+
+Start here as a template for creating an application with libcosmic's application API.
+
+```sh
+just run cosmic-design demo
+```
+
+## `open-dialog`
+
+Demonstrates how to create an open file dialog
+
+```sh
+just run open-dialog
+```
\ No newline at end of file
diff --git a/examples/open-dialog/Cargo.toml b/examples/open-dialog/Cargo.toml
index 71e32ac6..7e1a52dc 100644
--- a/examples/open-dialog/Cargo.toml
+++ b/examples/open-dialog/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "open_dialog"
+name = "open-dialog"
 version = "0.1.0"
 edition = "2021"