README.md in mee-rfc5424-0.1.0 vs README.md in mee-rfc5424-0.1.1

@@ -1,11 +1,9 @@
-# Mee::Rfc5424
+# MEE::Rfc5424
 
-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/mee/rfc5424`. To experiment with that code, run `bin/console` for an interactive prompt.
+Ruby loggger capable of logging against Syslog (RFC5424) over TCP and Syslog over TLS.  Logs may be in either non-transparent newline framing or octet counting framing.
 
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -20,17 +18,34 @@
 
     $ gem install mee-rfc5424
 
 ## Usage
 
-TODO: Write usage instructions here
+By default the loggers will use transparent octet counting.
 
+### TCP Syslog connection
+
+```ruby
+logger = MEE::RFC5424.tcp( 'syslog.host', 514 )
+logger.info { "TCP logging message" }
+```
+
+### TLS Syslog connection
+
+```ruby
+logger = MEE::RFC5424.tls( 'syslog.host', 10242 )
+logger.info { "TLS message logging" }
+```
+
 ## 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]/mee-rfc5424.
 
+## Licensing
+
+Licensed under the temrs of the MIT license