README.rdoc in bencode_blatyo-1.0.0 vs README.rdoc in bencode_blatyo-1.0.1
- old
+ new
@@ -1,24 +1,25 @@
-= BEncode 1.0
+= BEncode
* *Author* Allen Madsen (blatyo)
* *My* *Site* http://www.allenmadsen.com
* *Gem* http://gemcutter.org/gems/bencode_blatyo
* *Source* http://github.com/blatyo/bencode
* *Documentation* http://blatyo.github.com/bencode
+* *Issue* *Tracker* http://github.com/blatyo/bencode/issues
== Synopsis
This gem provides a way to encode and parse bencodings used by the Bit Torrent protocol.
== Installation
# install the gem
> gem install bencode_blatyo
- Successfully installed bencode_blatyo-1.0.0
+ Successfully installed bencode_blatyo
1 gem installed
- Installing ri documentation for bencode_blatyo-1.0.0...
- Building YARD (yri) index for bencode_blatyo-1.0.0...
- Installing RDoc documentation for bencode_blatyo-1.0.0.
+ Installing ri documentation for bencode_blatyo...
+ Building YARD (yri) index for bencode_blatyo...
+ Installing RDoc documentation for bencode_blatyo
# somefile.rb
require 'bencode'
== Examples
@@ -121,9 +122,16 @@
{:a => "a", :b => "b"}
end
end
BEncode::Dictionary.register MyClass
MyClass.new.bencode #=> "d1:a1:a1:b1:be"
+
+== Note on Reporting Issues
+
+* Try to make a failing test case
+* Tell me which version of ruby you're using
+* Tell me which OS you are using
+* Provide me with any extra files if necessary
== Note on Patches/Pull Requests
* Fork the project.
* Make your feature addition or bug fix.