Skip to content

Commit

Permalink
docs: add README
Browse files Browse the repository at this point in the history
  • Loading branch information
bashbunni committed May 30, 2024
0 parents commit eb02a0e
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).

<a href="https://charm.sh/"><img alt="The Charm logo" src="https://stuff.charm.sh/charm-badge.jpg" width="400"></a>

Charm热爱开源 • Charm loves open source

[charm]: https://github.com/charmbracelet/
[freeze]: https://github.com/charmbracelet/freeze
[vhs]: https://github.com/charmbracelet/vhs

0 comments on commit eb02a0e

Please sign in to comment.