From 90a8a6d385e957d8c5823a438bb95380d96531c9 Mon Sep 17 00:00:00 2001 From: Zac Nowicki Date: Sat, 10 Jun 2017 19:46:29 -0400 Subject: add other authors to shard.yml, detail README.md --- README.md | 26 ++++++++++++++++++++++++-- shard.yml | 7 +++++++ 2 files changed, 31 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 diff --git a/shard.yml b/shard.yml index 76aedf2..67fd43e 100644 --- a/shard.yml +++ b/shard.yml @@ -2,8 +2,15 @@ name: twitch version: 0.1.0 authors: + - Daniel Worral + - snapcase - Zac Nowicki crystal: 0.21.1 license: MIT + +dependencies: + fast-irc: + github: rx14/fast_irc.cr + version: 0.3.0 -- cgit v1.2.3