telepathy/README.md

38 lines
738 B
Markdown

# telepathy
TODO: Write a description here
## Installation
Add this to your application's `shard.yml`:
```yaml
dependencies:
telepathy:
github: [your-github-name]/telepathy
```
## Usage
```crystal
require "telepathy"
```
TODO: Write usage instructions here
## Development
TODO: Write development instructions here
## Contributing
1. Fork it ( https://github.com/[your-github-name]/telepathy/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
- [[your-github-name]](https://github.com/[your-github-name]) Danila Fedorin - creator, maintainer