Edit the README.

This commit is contained in:
Danila Fedorin 2018-01-12 18:15:03 -08:00
parent ac0c8823a3
commit 5b79a797da

View File

@ -1,9 +1,7 @@
# telepathy # telepathy
A fairly thin wrapper around the Telegram API, written for Crystal.
TODO: Write a description here
## Installation ## Installation
Add this to your application's `shard.yml`: Add this to your application's `shard.yml`:
```yaml ```yaml
@ -13,25 +11,9 @@ dependencies:
``` ```
## Usage ## Usage
```crystal ```crystal
require "telepathy" 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 ## Contributors
- [DanilaFe](http://dev.danilafe.com/DanilaFe) Danila Fedorin - creator, maintainer
- [[your-github-name]](https://github.com/[your-github-name]) Danila Fedorin - creator, maintainer