summaryrefslogtreecommitdiff
path: root/README.md
blob: 172ff0df781c5e5c8995fae3ab73a3ccaac8597b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# twitcr

API wrapper for interacting with Twitch.

## 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