README.md in libhoney-1.0.4 vs README.md in libhoney-1.1.0
- old
+ new
@@ -1,23 +1,29 @@
# libhoney [](https://travis-ci.org/honeycombio/libhoney-rb) [](https://badge.fury.io/rb/libhoney)
-Ruby gem for sending events to [Honeycomb](https://honeycomb.io). (See here for more information about [using Honeycomb](https://honeycomb.io/intro/) and [its libraries](https://honeycomb.io/docs/send-data/sdks).)
+Ruby gem for sending events to [Honeycomb](https://honeycomb.io). (For more information, see the [documentation](https://honeycomb.io/docs/) and [Ruby SDK guide](https://honeycomb.io/docs/connect/ruby).)
## Installation
To install the stable release:
```
gem install libhoney
```
-If you're using bundler, you can also reference the git repo and stay on the bleeding age by putting this in your `Gemfile`:
+or add `libhoney` to your Gemfile:
```
-gem 'libhoney', :git => 'http://github.com/honeycombio/libhoney-rb.git'
+gem 'libhoney'
+# or, to follow the bleeding edge:
+#gem 'libhoney', git: 'https://github.com/honeycombio/libhoney-rb.git'
```
+## Documentation
+
+An API reference is available at http://www.rubydoc.info/gems/libhoney
+
## Example Usage
Honeycomb can calculate all sorts of statistics, so send the values you care about and let us crunch the averages, percentiles, lower/upper bounds, cardinality -- whatever you want -- for you.
```ruby
@@ -54,7 +60,5 @@
version, run
```
bump patch --tag # Or bump minor --tag, etc.
git push --follow-tags
```
-
-Docs are generated via `rdoc` and hosted via the `gh-pages` branch of this repo.