More README

Author: liujed

README.md

@@ -1,6 +1,8 @@
-# Akita::HarLogger
+# Akita HTTP Archive (HAR) logger for Rack applications
+
+This provides Rack middleware for logging HTTP request–response pairs to a HAR
+file.
 
-Rack middleware for logging HTTP request–response pairs to a HAR file.
 
 ## Installation
 
@@ -18,9 +20,27 @@ Or install it yourself as:
 
     $ gem install akita-har_logger
 
+
 ## Usage
 
-TODO: Write usage instructions here
+To instrument your Rack application, add `Akita::HarLogger::Middleware` to the
+top of your middleware stack. For convenience, you can use
+`Akita::HarLogger.instrument`, as follows.
+
+1. In your main `application.rb`, make `Akita::HarLogger` available:
+    ```ruby
+    require 'akita/har_logger'
+    ```
+2. Add the following line to the bottom of your `Rails::Application`
+   subclass:
+   ```ruby
+   Akita::HarLogger.instrument(config, '/path/to/output/har_file.har')
+   ```
+
+Now, when you run your Rack application, all HTTP requests and responses will
+be logged to the HAR file that you've specified. You can then upload this HAR
+file to Akita for analysis.
+
 
 ## Development
 
@@ -34,6 +54,7 @@ release a new version, update the version number in `version.rb`, and then run
 git commits and the created tag, and push the `.gem` file to
 [rubygems.org](https://rubygems.org).
 
+
 ## Implementation notes
 
 References used when building this: