README.md in faraday-zipkin-0.0.1 vs README.md in faraday-zipkin-0.1.0
- old
+ new
@@ -1,16 +1,23 @@
# Faraday::Zipkin
Faraday middleware to generate Zipkin tracing headers.
+For more information about Zipkin, go to
+http://twitter.github.io/zipkin
+http://github.com/twitter/zipkin
+
+This gem implements the client side described at
+http://twitter.github.io/zipkin/instrument.html
+
Note that you should also be using the zipkin-tracer Rack middleware
to generate trace IDs around your requests:
https://github.com/twitter/zipkin/tree/master/zipkin-gems/zipkin-tracer
-Zipkin tracing headers are documented at
+Zipkin tracing headers for HTTP APIs are documented at
https://github.com/twitter/zipkin/blob/master/doc/collector-api.md
-
+
## Usage
Include Faraday::Zipkin::TraceHeaders as a Faraday middleware:
require 'faraday'
@@ -23,10 +30,10 @@
faraday.adapter Faraday.default_adapter
end
## Contributing
-1. Fork it ( https://github.com/[my-github-username]/faraday-zipkin/fork )
+1. Fork it ( https://github.com/Oscil8/faraday-zipkin/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