From 5b79a797da61f73fa05a7ce133c4b552818c77b0 Mon Sep 17 00:00:00 2001 From: Danila Fedorin Date: Fri, 12 Jan 2018 18:15:03 -0800 Subject: [PATCH] Edit the README. --- README.md | 22 ++-------------------- 1 file changed, 2 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index e3c1982..7808b74 100644 --- a/README.md +++ b/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