Permalink
Browse files

Add description and contributing notes.

  • Loading branch information...
rossf7 committed Nov 18, 2015
1 parent 6c30179 commit e7988a5768468731bb5404c16546adf975d0557b
Showing with 38 additions and 1 deletion.
  1. +16 −0 CONTRIBUTING.md
  2. +22 −1 README.md
View
@@ -0,0 +1,16 @@
+# Contribution Guidelines
+
+## Adding to this list
+
+Please ensure your pull request adheres to the following guidelines:
+
+- Make an individual pull request for each suggestion.
+- Use the following format: `[Resource Name](link) - Short description.`
+- Don't repeat the resource name in the description.
+- Link additions should be added in alphabetical order to the relevant category.
+- Titles should be [capitalized](http://grammar.yourdictionary.com/capitalization/rules-for-capitalization-in-titles.html).
+- Check your spelling and grammar.
+- New categories or improvements to the existing categorization are welcome.
+- The pull request and commit should have a useful title.
+
+Thank you for your suggestions!
View
@@ -1,2 +1,23 @@
# awesome-microscaling
-A curated list of Microscaling related principles and technologies.
+A curated list of Microscaling related principles and technologies inspired by [awesome-microservices](https://github.com/mfornos/awesome-microservices). Microscaling.org redirects here.
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## License
+
+[![CC0](http://i.creativecommons.org/p/zero/1.0/88x31.png)](http://creativecommons.org/publicdomain/zero/1.0/)
+
+## Contributing
+
+Please, read the [Contribution Guidelines](https://github.com/force12io/awesome-microscaling/blob/master/CONTRIBUTING.md) before submitting your suggestion.
+
+Feel free to [open an issue](https://github.com/force12io/awesome-microscaling/issues) or [create a pull request](https://github.com/force12io/awesome-microscaling/pulls) with your additions.
+
+:star2: Thank you!
+
+## Acknowledgments
+
+Table of contents generated with [DocToc](https://github.com/thlorenz/doctoc)

0 comments on commit e7988a5

Please sign in to comment.