README.md in plate_api-0.4.0 vs README.md in plate_api-1.0.0
- old
+ new
@@ -1,11 +1,15 @@
+
+[](https://badge.fury.io/rb/plate_api)
+[](https://travis-ci.com/platehub/plate_api)
+[](https://codeclimate.com/github/platehub/plate_api/maintainability)
+[](https://codeclimate.com/github/platehub/plate_api/test_coverage)
# PlateApi
-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/plate_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+Welcome to the PlateApi gem. This gem provides a wrapper to communicate with the Plate API, taking care of
+authentication.
-TODO: Delete this and the text above, and describe your gem
-
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -18,22 +22,37 @@
Or install it yourself as:
$ gem install plate_api
-## Usage
+## Getting started
-TODO: Write usage instructions here
+To get started with a simple connector:
+```
+# Initialze a connector
+con == PlateApi::Connector.new("{{public_key}}", "{{secret_key}}")
+
+# Find information of a specific site with id == 822
+site = con.sites.find(822)
+
+# Find all posts in this site
+posts = site.posts
+
+# Find all elements in the first post of this site
+first_post = posts.first
+elements = first_post.elements
+
+# Update the content field 'body' of the first element
+element = elements.first
+element.update(body: "<h2>My new text</h2>")
+```
+
## Development
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.
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).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/plate_api.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).