Merge pull request magicmonkey#25 from lornajane/contributing

Add a contributing file, some TOCs and a section for the showcase

Author: magicmonkey

CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# Contributing to Go-Streamdeck
+
+All issues, pull requests and other feedback are very welcome in this project. Please do take the time to read the information below, and get involved!
+
+- [Use Go-Streamdeck From Source](#use-go-streamdeck-from-source)
+- [Share Issues, Bugs and Feature Requests](#share-issues-bugs-and-feature-requests)
+- [Submit a Patch or Pull Request](#submit-a-patch-or-pull-request)
+- [Try the Examples](#try-the-examples)
+- [Usage in Other Projects](#usage-in-other-projects)
+
+## Use Go-Streamdeck From Source
+
+To use the `master` branch, another branch, or a branch in your own fork, you can use the `replace` syntax in your `go.mod` file. For more information and an example try this [excellent blog post from Pam Selle](https://thewebivore.com/using-replace-in-go-mod-to-point-to-your-local-module/).
+
+## Share Issues, Bugs and Feature Requests
+
+Go ahead and open an issue, choosing whether you are making a bug report, or a feature request. If it's both, or neither, just pick one! The only difference is the template you are prompted to complete. It's fine to ask questions and support queries by opening an issue on this repository too.
+
+## Submit a Patch or Pull Request
+
+You will need to fork the repository to offer patches. Please make sure your master branch is up to date, then start a new branch, named for the feature/bugfix it contains.
+
+For large changes, please open an issue for discussion so that we know we are not duplicating work or working on a feature that won't be accepted at the end of the process.
+
+## Try the Examples
+
+The `examples/` directory has a series of examples that may be useful in your own applications. Try these out to see the various features in action.
+
+Please open an issue to update us for which operating systems and StreamDeck combinations are working well for you!
+
+## Usage in Other Projects
+
+You are very welcome to use this project within the terms of the license. We would love to have you in our showcase, please open a pull request to update the `README.md` file with a link to your project.

README.md

@@ -6,6 +6,13 @@ A Go interface to an Elgato Streamdeck (currently works with the 32-button XL on
 
 _Designed for and tested with Ubuntu, Go 1.13+ and a Streamdeck XL. Images are the wrong size for other streamdecks; bug reports and patches are welcome!_
 
+- [Installation](#installation)
+- [Usage](#usage)
+  * [Example high-level usage](#example-high-level-usage)
+  * [Example low-level usage](#example-low-level-usage)
+- [Showcase](#showcase)
+- [Contributions](#contributions)
+
 ## Installation
 
 Either include the library in your project or install it with the following command:
@@ -109,6 +116,14 @@ func main() {
 
 The program runs for 20 seconds and then exits.
 
+## Showcase
+
+Projects using this library (pull request to add yours!)
+
+* [Streamdeck tricks](https://github.com/lornajane/streamdeck-tricks)
+
 ## Contributions
 
 This is a very new project but all feedback, comments, questions and patches are more than welcome. Please get in touch by opening an issue, it would be good to hear who is using the project and how things are going.
+
+For more, see [CONTRIBUTING.md](CONTRIBUTING.md).