README.md in libhoney-1.0.0 vs README.md in libhoney-1.0.2
- old
+ new
@@ -1,19 +1,10 @@
-libhoney
-========
-Ruby gem for sending events to http://honeycomb.io from within your ruby code.
+# libhoney [](https://travis-ci.org/honeycombio/libhoney-rb) [](https://badge.fury.io/rb/libhoney)
-[](https://travis-ci.com/honeycombio/libhoney-rb)
-## Summary
+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).)
-libhoney is written to ease the process of sending data to Honeycomb from within
-your ruby code.
-
-For an overview of how to use a honeycomb library, see our documentation at
-https://honeycomb.io/docs/send-data/sdks/
-
## Installation
To install the stable release:
```
@@ -25,33 +16,45 @@
```
gem 'libhoney', :git => 'http://github.com/honeycombio/libhoney-rb.git'
```
## 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
require 'libhoney'
-# create a client instance
-honey = Libhoney::Client.new(:writekey => "your writekey",
- :dataset => "your dataset")
+# Create a client instance
+honeycomb = Libhoney::Client.new(:writekey => "YOUR_WRITE_KEY",
+ :dataset => "honeycomb-ruby-example")
-# create an event and add fields to it
-event = honey.event
-event.add_field("duration_ms", 153.12)
-event.add_field("method", "get")
-# send the event
-event.send
+honeycomb.send_now({
+ duration_ms: 153.12,
+ method: "get",
+ hostname: "appserver15",
+ payload_length: 27
+})
-# when all done, call close
-honey.close
+# Call close to flush any pending calls to Honeycomb
+honeycomb.close
```
-You can find a more complete example demonstrating usage in `example/fact.rb`
+You can find a more complete example demonstrating usage in [`example/fact.rb`](example/fact.rb)
## Contributions
Features, bug fixes and other changes to libhoney are gladly accepted. Please
open issues or a pull request with your change. Remember to add your name to the
CONTRIBUTORS file!
All contributions will be released under the Apache License 2.0.
+
+### Releasing a new version
+
+Travis will automatically upload tagged releases to Rubygems. To release a new
+version, run
+```
+bump patch --tag # Or bump minor --tag, etc.
+git push --follow-tags
+```