diff --git a/README.md b/README.md new file mode 100644 index 0000000..c251ead --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +![Version](https://img.shields.io/wordpress/plugin/dt/delightful-downloads.svg) ![Rating](https://img.shields.io/wordpress/plugin/r/delightful-downloads.svg) + +## Bugs + +If you find a bug, please raise it [here](https://github.com/A5hleyRich/delightful-downloads/issues). + +## Contributions + +Anyone is welcome to contribute to Delightful Downloads. There are various ways to do so: + +* Report a bug on GitHub +* Send a Pull Request with your bug fixes and/or new features +* [Translate](https://www.transifex.com/projects/p/delightful-downloads/) Delightful Downloads into different languages +* Provide feedback and suggestions on enhancements + +## Development + +Development should be performed on the __develop__ branch. After cloning the __develop__ branch to your local machine you should run: + +`npm install` + +Followed by: + +`grunt` + +This will build the required CSS files. + +If you require the localisation files you will need to install the [Transifex client](http://docs.transifex.com/client/setup/) and then run: + +`grunt translate` \ No newline at end of file