From 6257c096bb941241147aef397de1d901f76a7005 Mon Sep 17 00:00:00 2001 From: Tamer Tas Date: Wed, 23 Dec 2015 15:46:52 +0200 Subject: [PATCH] Update README and Contribution Guidelines --- CONTRIBUTING.md | 7 +++++++ README.md | 24 ++++++++++++++++++++---- 2 files changed, 27 insertions(+), 4 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3eac910 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,7 @@ +# Contribution Guidelines + +Please ensure your pull request adheres to the following guidelines: + +- Make an individual pull request for each suggestion. +- Chose corresponding section of patterns for your suggestion. +- List, after your addition, should be alphabetically. diff --git a/README.md b/README.md index 36acac4..747f404 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ -# awesome-go-patterns - A collection of Go design patterns/idioms - -Current Patterns: +# Go Patterns [![Awesome Widget]][Awesome] [![Travis Widget]][Travis] [![License Widget]][License] +[Awesome Widget]: https://img.shields.io/badge/awesome-%E2%9C%93-ff69b4.svg?style=flat-square +[Awesome]: https://github.com/sindresorhus/awesome +[Travis Widget]: https://img.shields.io/travis/tmrts/awesome-google-cloud.svg?style=flat-square +[Travis]: http://travis-ci.org/tmrts/go-patterns +[License Widget]: https://img.shields.io/badge/license-Creative%20Commons%204.0-E91E63.svg?style=flat-square +[License]: http://creativecommons.org/licenses/by/4.0/ +A curated collection of common patterns & idioms for Go. __Creational Patterns__: @@ -48,3 +52,15 @@ __Behavioral Patterns__: | [strategy](strategy.go) | selectable operations over the same data | | [template](template.go) | an object imposes a structure but takes pluggable components | | [visitor](visitor.go) | invoke a callback for all items of a collection | + +__Concurrency Patterns__: + +| Pattern | Description | +|:-------:| ----------- | +| [semaphore](semaphore.go) | data type for controlling access, to a common resource| + +# License + +[![Creative Commons License](http://i.creativecommons.org/l/by/4.0/88x31.png)](http://creativecommons.org/licenses/by/4.0/) + +This work is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).