diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..67eded4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Contribution Guidelines + +Please ensure your pull request adheres to the following guidelines: + +- Search previous suggestions before making a new one, as yours may be a duplicate. +- If you just created something, wait at least a couple of weeks before submitting. +- Make an individual pull request for each suggestion. +- Use the following format: `[resource name](link) - Description.` +- New categories, or improvements to the existing categorization are welcome. +- Keep descriptions short and simple, but descriptive. +- Don't mention `IPFS` in the description as it's implied. +- Start the description with a capital and end with a full stop/period. +- Check your spelling and grammar. +- Make sure your text editor is set to remove trailing whitespace. +- The pull request should have a useful title and include a link to the package and why it should be included. + +Thank you for your suggestions! diff --git a/README.md b/README.md index 2bdc6e2..cb4a40c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,12 @@ -# awesome-ipfs -All awesome ipfs things +# Awesome IPFS [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome) + +> Useful resources for using IPFS and building things on top of it + +*Inspired by the [awesome](https://github.com/sindresorhus/awesome) list thing.* + + + + +## License + +[![CC0](http://i.creativecommons.org/p/zero/1.0/88x31.png)](http://creativecommons.org/publicdomain/zero/1.0/)