summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorZac Nowicki <zachnowicki@gmail.com>2017-06-10 19:05:16 -0400
committerZac Nowicki <zachnowicki@gmail.com>2017-06-10 19:05:16 -0400
commit7bffddb3f750f2313909063dbca592433bd2e7ab (patch)
treedd58b2ef4ba10bf9f4d858cf38f64866710abe1a /README.md
downloadtwitch-7bffddb3f750f2313909063dbca592433bd2e7ab.tar.gz
twitch-7bffddb3f750f2313909063dbca592433bd2e7ab.zip
initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ac49868
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# twitch
+
+A binding to the [Twitch API](https://dev.twitch.tv/docs) implemented in [Crystal](https://crystal-lang.org/).
+
+## Installation
+
+Add this to your application's `shard.yml`:
+
+```yaml
+dependencies:
+ twitch:
+ github: y32/twitch
+```
+
+## Usage
+
+```crystal
+require "twitch"
+```
+
+TODO: Write usage instructions here
+
+## Contributors
+
+- [Daniel-Worral](https://github.com/Daniel-Worrall) - creator, maintainer, spec-man extraordinaire
+- [snapcase](https://github.com/snapcase) - creator, maintainer, IRC expert
+- [z64](https://github.com/z64) - creator, maintainer, script kiddie