diff options
author | Zac Nowicki <zachnowicki@gmail.com> | 2017-06-10 19:46:29 -0400 |
---|---|---|
committer | Zac Nowicki <zachnowicki@gmail.com> | 2017-06-10 19:46:29 -0400 |
commit | 90a8a6d385e957d8c5823a438bb95380d96531c9 (patch) | |
tree | 775d48a513df6eaf0be58aa2573058e39692150c | |
parent | 7bffddb3f750f2313909063dbca592433bd2e7ab (diff) | |
download | twitch-90a8a6d385e957d8c5823a438bb95380d96531c9.tar.gz twitch-90a8a6d385e957d8c5823a438bb95380d96531c9.zip |
add other authors to shard.yml, detail README.md
-rw-r--r-- | README.md | 26 | ||||
-rw-r--r-- | shard.yml | 7 |
2 files changed, 31 insertions, 2 deletions
@@ -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 @@ -2,8 +2,15 @@ name: twitch version: 0.1.0 authors: + - Daniel Worral <Daniel.Worrall@hotmail.co.uk> + - snapcase <snapcase@octalzeroes.com> - Zac Nowicki <zachnowicki@gmail.com> crystal: 0.21.1 license: MIT + +dependencies: + fast-irc: + github: rx14/fast_irc.cr + version: 0.3.0 |