Mirror of https://github.com/roostorg/playground
github.com/roostorg/playground
README: add eligibility and instructions to add projects
authored by
Cassidy James Blaede
and committed by
GitHub
58cf559a
f84ac225
+19
-1
+19
-1
README.md
+19
-1
README.md
···
1
1
# playground
2
-
Community demos and projects built on or from ROOST projects
2
+
3
+
Community demos and projects built on or from ROOST projects. Projects listed in this repo are not developed or endorsed by ROOST, and may not be intended for production use. Check each project’s documentation for details.
4
+
5
+
## Project eligibility
6
+
7
+
- Built on, from, or to be used with an existing ROOST open source project (otherwise, please add it to [Awesome Safety Tools](https://github.com/roostorg/awesome-safety-tools))
8
+
9
+
- Accessible on the web, ideally with source code
10
+
11
+
## Adding a project
12
+
13
+
Projects live in `_data/projects.yml`. Open a pull request to add your own project, ensuring you include:
14
+
15
+
1. Title
16
+
2. Description
17
+
3. URL
18
+
4. Tags (see existing projects for reference)
19
+
20
+
Someone from @roostorg/roosters will review and merge your pull request if approved!