From 99b3d7287bd0ac36ee82129ad38bd88c5b5af625 Mon Sep 17 00:00:00 2001
From: Jonathan B <greenbigfrog@gmail.com>
Date: Wed, 14 Aug 2019 21:25:02 +0200
Subject: Initial release

---
 README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..04ea7f1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# twitcr
+
+Very limited API Rest wrapper for interacting with twitch. Not planning on finishing.
+
+## Installation
+
+1. Add the dependency to your `shard.yml`:
+
+   ```yaml
+   dependencies:
+     twitcr:
+       github: your-github-user/twitcr
+   ```
+
+2. Run `shards install`
+
+## Usage
+
+```crystal
+require "twitcr"
+
+Twitcr::Client.new(oauth_token, oauth_id).user?(channel)
+```
+
+TODO: Write usage instructions here
+
+## Development
+
+TODO: Write development instructions here
+
+## Contributing
+
+1. Fork it (<https://github.com/your-github-user/twitcr/fork>)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Contributors
+
+- [Jonathan B.](https://github.com/your-github-user) - creator and maintainer
-- 
cgit v1.2.3