README.md in f5-icontrol-0.1.0 vs README.md in f5-icontrol-0.1.1
- old
+ new
@@ -11,11 +11,11 @@
* Improve testing using rspec and vcr
* Convert to a supported SOAP parser, such as savon
* Support Ruby 2.0.0 and 2.1.0
* Make the interface to the library more Ruby-esque
-But given the original one was pretty straightforward I decided to start over.
+But given the original one was pretty bare-bones, I started over.
## Installation
Add this line to your application's Gemfile:
@@ -29,10 +29,27 @@
$ gem install f5-icontrol
## Usage
-See examples subdir.
+First, configure the gem:
+
+```Ruby
+F5::Icontrol.configure do |f|
+ f.host = "hostname.of.bigip"
+ f.username = "username"
+ f.password = "password"
+end
+```
+
+Then use it:
+
+```Ruby
+api = F5::Icontrol::API.new
+response = api.LocalLB.Pool.get_list
+```
+
+See specs subdir for more examples, especially as it pertains to passing parameters.
## CLI
There's a command line version that's still being roughed out. You'll need a `~/.f5.yml` file containing your login information: