aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bcc1d87
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# saucesource
+
+The web cookbook that doesn't suck.
+
+## Publishing your recipe
+
+Send a git patch with your recipe and if it's (not bloated) fine I'll merge it.
+Every recipe is kept in its one folder under the `content/recipes/` directory.
+The name of the directory should be the approx date you submit your recipe
+followed by the name/slug of the recipe.
+
+For more information read
+[http://saucesource.cc/about/](http://saucesource.cc/about/)
+
+Take a look at the `content/recipes/` directory for examples of recipes and how
+to format them.
+
+## TODO
+
+* Add dark pallet using prefers-color-scheme
+* Finish Russian and Spanish translations
+* Maybe add some kind of search functionality on the backend
+* Maybe add some way to categorize recipes
+
+## License
+
+By contributing recipes to this project you agree to submit them under the
+CC-BY-SA 3.0 license. Any contributions related to the functioning of the site
+(stylesheets, templates) are licensed under the AGPLv3 license. For more
+information read the LICENSE file.