From eb02a0e13f0213746b2856b151b10181360646d2 Mon Sep 17 00:00:00 2001 From: bashbunni Date: Thu, 30 May 2024 12:56:28 -0700 Subject: [PATCH] docs: add README --- README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..48a356b --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# Strutt your stuff + +This is your one-stop shop to find *incredible* community projects built with +the [Charm][charm] stack. Get inspired, and most importantly, get building! + +## The Concept + +This is an entirely community-driven repo for members of the community to share +their projects. You can PR your completed projects to be included in the list. + +You're also welcome to contribute ideas without building them out. +## What is a "Complete" Project + +A project is considered complete when: +1. It implements the minimum viable product for the idea +2. It includes a `README` with screenshots or a GIF describing the + application's behavior. See [Freeze][freeze] or [VHS][vhs] for easy demos. + +> [!NOTE] +> Please include an overview of what Charm libraries you used to build your project. + + +## Feedback + +We’d love to hear your thoughts on this project. Join the chatter happening on [Discord](https://charm.sh/chat). + +## License + +[MIT](https://github.com/charmbracelet/skate/raw/main/LICENSE) + +*** + +Part of [Charm](https://charm.sh). + +The Charm logo + +Charm热爱开源 • Charm loves open source + +[charm]: https://github.com/charmbracelet/ +[freeze]: https://github.com/charmbracelet/freeze +[vhs]: https://github.com/charmbracelet/vhs