Skip to content

Commit

Permalink
chore: create README for projects directory
Browse files Browse the repository at this point in the history
  • Loading branch information
gbj authored Apr 19, 2024
1 parent 2960dad commit 9353316
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions projects/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# `projects` README

The `projects` directory is intended as a collective of medium-to-large-scale examples: a place to show a variety of use cases and integrations between Leptos and other libraries. Over time, our hope is that this allows us to showcase a wider variety of user examples, without the main `examples` directory becoming too overwhelming to be useful.

The `examples` directory is included in our CI, and examples are regularly linted and tested. The barrier to entry for the `projects` directory is intended to be lower: Example projects will generally be built against a particular version, and not regularly linted or updated. Hopefully this distinction allows us to accept more examples without worrying about the maintenance burden of constant updates.

Feel free to submit projects to this directory via PR!

0 comments on commit 9353316

Please sign in to comment.