From 9353316947a6350b9fc54885e6681b8df4b0a616 Mon Sep 17 00:00:00 2001 From: Greg Johnston Date: Fri, 19 Apr 2024 10:39:58 -0400 Subject: [PATCH] chore: create README for `projects` directory --- projects/README.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 projects/README.md diff --git a/projects/README.md b/projects/README.md new file mode 100644 index 0000000000..5018c3e7c4 --- /dev/null +++ b/projects/README.md @@ -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!