diff --git a/README.md b/README.md new file mode 100644 index 0000000..efe765a --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# isitbulkweekincleveland.com + +A website that has one purpose: Is it bulk week this week ? (and maybe tell you when the next bulk week is). + +In the city of Cleveland, residents are allowed to put out bulk items once a month. It is usually the first week of the month but it varies. + +Many people in the neighborhood Facebook groups ask when is bulk week. This website answers it. + +### Errors / Bugs: + +If something is not behaving as you expected, it could be a bug, or if you have an idea, it can be reported in our issue tracker at https://github.com/opencleveland/refundcleveland + +## How to become involved: + +Email opencleveland@gmail.com + +## Developer Instructions + +### Configuring and running locally + +Pre-Requisites: + +#### Clone repo and install requirements + +### Note on Patches/Pull Requests + +* Fork the project. +* Make your feature addition or bug fix. +* Send us a pull request. Bonus points for making a new name for your branch that describes your changes. For example, if you're improving the css by adding margins for input range element, `css-range-margins` would be appropriate. + +### Copyright + +MIT License