Permalink
Browse files

Improved documentation

  • Loading branch information...
1 parent af7df7a commit 1bd236dba6be956734fb83425eecade70c468f8d @davidmiani davidmiani committed Sep 22, 2011
Showing with 26 additions and 18 deletions.
  1. +1 −1 LICENSE.txt
  2. +19 −12 README.rdoc
  3. +1 −1 VERSION
  4. +4 −3 lib/wire2air.rb
  5. +1 −1 wire2air.gemspec
View
@@ -1,4 +1,4 @@
-Copyright (c) 2011 David Miani
+Copyright (c) 2011 Wire2Air
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
View
@@ -1,17 +1,24 @@
= Wire2Air
-Description goes here.
-
-== Contributing to wire2air:w
-
-
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+This is a ruby library that allows interaction with the wire2air api service.
+
+== Installation
+
+ gem install wire2air
+
+== Example Usage
+
+ require 'wire2air'
+ connection = Wire2Air.new(:username => 'your_username',
+ :password => 'your password',
+ :profile_id => 42,
+ :vasid => 12345) # replace the options with the ones found for your account
+ short_code = 234 # replace with the shortcode from your account you wish to use
+ test_number = "123456789"
+ connection.submit_sm(short_code, test_number, "A message to send")
+
+See rdoc/ri for details on other methods, they are pretty simple to use.
+
== Copyright
View
@@ -1 +1 @@
-0.3.3
+0.3.4
View
@@ -6,9 +6,10 @@
# connection = Wire2Air.new(:username => 'your_username',
# :password => 'your password',
# :profile_id => 42,
-# :from => 1111,
-# :vasid => 12345)
-# connection.submit_sm()
+# :vasid => 12345) # replace the options with the ones found for your account
+# short_code = 234 # replace with the shortcode from your account you wish to use
+# test_number = "123456789"
+# connection.submit_sm(short_code, test_number, "A message to send")
class Wire2Air
View
@@ -5,7 +5,7 @@
Gem::Specification.new do |s|
s.name = %q{wire2air}
- s.version = "0.3.3"
+ s.version = "0.3.4"
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
s.authors = [%q{Wire2Air}]

0 comments on commit 1bd236d

Please sign in to comment.