diff --git a/README.md b/README.md new file mode 100644 index 0000000..a22a298 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# yesod-cookbook + +This repository houses snippets, techniques for solving practical +problems with Yesod. + +You can view the pages here: +* [Cookbook](https://github.com/yesodweb/yesod-cookbook/blob/master/Cookbook.md) +* [Snippets](https://github.com/yesodweb/yesod-cookbook/blob/master/Snippets.md) + + +## How to contribute? + +### Creating a new Cookbook page + +All the pages related to cookbook are inside the directory +`cookbook-pages`. Create a new file inside it and add a corresponding +link for it in the +[Cookbook section](https://github.com/yesodweb/yesod-cookbook/blob/master/Cookbook.md) + +### Creating a new Snippet page + +All the pages related to cookbook are inside the directory +`snippets`. Create a new file inside it and add a corresponding +link for it in the +[Snippets section](https://github.com/yesodweb/yesod-cookbook/blob/master/Snippets.md)