summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorZac Nowicki <zachnowicki@gmail.com>2017-06-10 19:46:29 -0400
committerZac Nowicki <zachnowicki@gmail.com>2017-06-10 19:46:29 -0400
commit90a8a6d385e957d8c5823a438bb95380d96531c9 (patch)
tree775d48a513df6eaf0be58aa2573058e39692150c /README.md
parent7bffddb3f750f2313909063dbca592433bd2e7ab (diff)
downloadtwitch-90a8a6d385e957d8c5823a438bb95380d96531c9.tar.gz
twitch-90a8a6d385e957d8c5823a438bb95380d96531c9.zip
add other authors to shard.yml, detail README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 24 insertions, 2 deletions
diff --git a/README.md b/README.md
index ac49868..88c1221 100644
--- a/README.md
+++ b/README.md
@@ -14,11 +14,33 @@ dependencies:
## Usage
+There are several main components to the library:
+
+- `Twitch::Kraken` - Client for interacting with Twitch's REST API
+
```crystal
-require "twitch"
+require "twitch/kraken"
+
+twitch = Twitch::Kraken.new(token: "cfabdegwdoklmawdzdo98xt2fo512y")
```
-TODO: Write usage instructions here
+Refer to the documentation for the kinds of requests you can make with this client.
+
+- `Twitch::IRC` - Client for building IRC applications
+
+```crystal
+require "twitch/irc"
+
+bot = Twitch::IRC.new(nick: "nekka", token: "cfabdegwdoklmawdzdo98xt2fo512y")
+
+# Create a handler to process incoming messages
+bot.on_message do |message|
+ # handle this message
+end
+
+# Connect to Twitch
+bot.run!
+```
## Contributors