Edit the README.
This commit is contained in:
parent
ac0c8823a3
commit
5b79a797da
22
README.md
22
README.md
|
@ -1,9 +1,7 @@
|
|||
# telepathy
|
||||
|
||||
TODO: Write a description here
|
||||
A fairly thin wrapper around the Telegram API, written for Crystal.
|
||||
|
||||
## Installation
|
||||
|
||||
Add this to your application's `shard.yml`:
|
||||
|
||||
```yaml
|
||||
|
@ -13,25 +11,9 @@ dependencies:
|
|||
```
|
||||
|
||||
## 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
|
||||
- [DanilaFe](http://dev.danilafe.com/DanilaFe) Danila Fedorin - creator, maintainer
|
||||
|
|
Loading…
Reference in New Issue
Block a user