From 58cf559a397109be97ccaee3ad536b61c04f1b4b Mon Sep 17 00:00:00 2001 From: Cassidy James Blaede Date: Thu, 9 Apr 2026 17:25:34 -0600 Subject: [PATCH] README: add eligibility and instructions to add projects --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e76e54b..20e9d9a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ # playground -Community demos and projects built on or from ROOST projects + +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. + +## Project eligibility + +- 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)) + +- Accessible on the web, ideally with source code + +## Adding a project + +Projects live in `_data/projects.yml`. Open a pull request to add your own project, ensuring you include: + +1. Title +2. Description +3. URL +4. Tags (see existing projects for reference) + +Someone from @roostorg/roosters will review and merge your pull request if approved! -- 2.51.2