README.md in telegraph_api-0.1.0 vs README.md in telegraph_api-0.1.1
- old
+ new
@@ -1,11 +1,9 @@
# TelegraphApi
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/telegraph_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem wraps Telegraph API for convenient usage with Ruby
-TODO: Delete this and the text above, and describe your gem
-
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -20,20 +18,22 @@
$ gem install telegraph_api
## Usage
-TODO: Write usage instructions here
+```ruby
+require 'telegraph_api'
-## Development
+page = Telegraph::Page.get(path: 'Sample-Page-12-15')
+```
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Gem provides two namespaces for common usage:
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+`Telegraph::Page` for page methods and `Telegraph::Account` for account manipulation
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/telegraph_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/deff7/ruby_telegraph_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).