diff options
-rw-r--r-- | .gitignore | 8 | ||||
-rw-r--r-- | .travis.yml | 1 | ||||
-rw-r--r-- | LICENSE | 21 | ||||
-rw-r--r-- | README.md | 27 | ||||
-rw-r--r-- | shard.yml | 9 | ||||
-rw-r--r-- | spec/spec_helper.cr | 2 | ||||
-rw-r--r-- | spec/twitch_spec.cr | 9 | ||||
-rw-r--r-- | src/twitch.cr | 5 | ||||
-rw-r--r-- | src/twitch/version.cr | 3 |
9 files changed, 85 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..23ec656 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +/doc/ +/lib/ +/bin/ +/.shards/ + +# Libraries don't need dependency lock +# Dependencies will be locked in application that uses them +/shard.lock diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..ffc7b6a --- /dev/null +++ b/.travis.yml @@ -0,0 +1 @@ +language: crystal @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2017 y32 + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. 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 diff --git a/shard.yml b/shard.yml new file mode 100644 index 0000000..76aedf2 --- /dev/null +++ b/shard.yml @@ -0,0 +1,9 @@ +name: twitch +version: 0.1.0 + +authors: + - Zac Nowicki <zachnowicki@gmail.com> + +crystal: 0.21.1 + +license: MIT diff --git a/spec/spec_helper.cr b/spec/spec_helper.cr new file mode 100644 index 0000000..284aa89 --- /dev/null +++ b/spec/spec_helper.cr @@ -0,0 +1,2 @@ +require "spec" +require "../src/twitch" diff --git a/spec/twitch_spec.cr b/spec/twitch_spec.cr new file mode 100644 index 0000000..abf0780 --- /dev/null +++ b/spec/twitch_spec.cr @@ -0,0 +1,9 @@ +require "./spec_helper" + +describe Twitch do + # TODO: Write tests + + it "works" do + false.should eq(true) + end +end diff --git a/src/twitch.cr b/src/twitch.cr new file mode 100644 index 0000000..9f7963c --- /dev/null +++ b/src/twitch.cr @@ -0,0 +1,5 @@ +require "./twitch/*" + +module Twitch + # TODO Put your code here +end diff --git a/src/twitch/version.cr b/src/twitch/version.cr new file mode 100644 index 0000000..7044034 --- /dev/null +++ b/src/twitch/version.cr @@ -0,0 +1,3 @@ +module Twitch + VERSION = "0.1.0" +end |