shard-spectator/README.md

40 lines
755 B
Markdown
Raw Normal View History

2024-06-06 22:25:39 +00:00
# spectator
2018-08-18 21:33:20 +00:00
2024-06-06 22:25:39 +00:00
TODO: Write a description here
2018-08-18 21:33:20 +00:00
2024-06-06 22:25:39 +00:00
## Installation
2018-11-02 20:32:36 +00:00
2024-06-06 22:25:39 +00:00
1. Add the dependency to your `shard.yml`:
2018-11-02 20:32:36 +00:00
2024-06-06 22:25:39 +00:00
```yaml
dependencies:
spectator:
github: icy-arctic-fox/spectator
```
2018-11-02 20:32:36 +00:00
2024-06-06 22:25:39 +00:00
2. Run `shards install`
2018-08-18 21:33:20 +00:00
2024-06-06 22:25:39 +00:00
## Usage
2018-08-18 21:33:20 +00:00
```crystal
2019-08-28 17:10:14 +00:00
require "spectator"
```
2024-06-06 22:25:39 +00:00
TODO: Write usage instructions here
2018-08-18 21:33:20 +00:00
2024-06-06 22:25:39 +00:00
## Development
2019-03-31 18:47:34 +00:00
2024-06-06 22:25:39 +00:00
TODO: Write development instructions here
2019-03-28 02:08:06 +00:00
2024-06-06 22:25:39 +00:00
## Contributing
2019-03-28 02:08:06 +00:00
2024-06-06 22:25:39 +00:00
1. Fork it (<https://github.com/icy-arctic-fox/spectator/fork>)
2018-08-18 21:33:20 +00:00
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`)
2024-06-06 22:25:39 +00:00
5. Create a new Pull Request
2020-03-28 16:06:54 +00:00
2024-06-06 22:25:39 +00:00
## Contributors
2018-08-18 21:33:20 +00:00
2024-06-06 22:25:39 +00:00
- [Michael Miller](https://github.com/icy-arctic-fox) - creator and maintainer