README.md in mpd_client-0.0.6 vs README.md in mpd_client-0.1.0

- old
+ new

@@ -1,7 +1,10 @@ -# MPDClient +# MPD::Client +[![Build Status](https://badgen.net/travis/mamantoha/mpd_client)](https://travis-ci.org/mamantoha/mpd_client) +[![Gem Version](https://badge.fury.io/rb/mpd_client.svg)](https://badge.fury.io/rb/mpd_client) + Yet another Music Player Daemon (MPD) client library written entirely in Ruby. `mpd_client` is a Ruby port of the [python-mpd](https://github.com/Mic92/python-mpd2) library. ## Installation @@ -11,28 +14,29 @@ gem 'mpd_client' ``` And then execute: +```console +bundle ``` -$ bundle -``` Or install it yourself as: +```console +gem install mpd_client ``` -$ gem install mpd_client -``` ## Usage -All functionality is contained in the `MPDClient` class. Creating an instance of this class is as simple as: +All functionality is contained in the `MPD::Client` class. Creating an instance of this class is as simple as: + ```ruby -client = MPDClient.new +client = MPD::Client.new ``` -Once you have an instance of the `MPDClient` class, start by connecting to the server: +Once you have an instance of the `MPD::Client` class, start by connecting to the server: ```ruby client.connect('localhost', 6600) ``` @@ -76,32 +80,32 @@ client.delete([10,]) ``` ### Logging -Default logger for all MPDClient instances: +Default logger for all MPD::Client instances: ```ruby require 'logger' require 'mpd_client' -MPDClient.log = Logger.new($stderr) +MPD::Client.log = Logger.new($stderr) -client = MPDClient.new +client = MPD::Client.new ``` -Sets the logger used by this instance of MPDClient: +Sets the logger used by this instance of MPD::Client: ```ruby require 'logger' require 'mpd_client' -client = MPDClient.new +client = MPD::Client.new client.log = Logger.new($stderr) ``` -For more information about logging configuration, see http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html +For more information about logging configuration, see [Logger](https://ruby-doc.org/stdlib-2.5.1/libdoc/logger/rdoc/Logger.html) ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. @@ -115,8 +119,8 @@ 4. Push to the branch (`git push origin my-new-feature`) 5. Create new Pull Request ## License and Author -Copyright (c) 2013-2017 by Anton Maminov +Copyright (c) 2013-2018 by Anton Maminov This library is distributed under the MIT license. Please see the LICENSE file.