YARD: Render History.txt as RDoc

- drop bad whitespace in README - add a yardopts file
socketry · Mar 3, 2019 · d81d1ae · d81d1ae
1 parent 64d2da7
commit d81d1ae
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 5 deletions.
diff --git a/.yardopts b/.yardopts
@@ -0,0 +1,6 @@
+--no-private
+lib/**/.rb
+-
+History.txt
+LICENSE
+README.md
diff --git a/History.txt b/History.txt
@@ -1,3 +1,8 @@
+<!--
+# @markup rdoc
+# @title CHANGELOG
+-->
+
 === 2.0.0 / 2013-12-21
 
 - Drop Ruby 1.8 compatibility
@@ -57,4 +62,3 @@
 * 1 major enhancement
 
   * Birthday!
-
diff --git a/README.md b/README.md
@@ -8,15 +8,15 @@ methods besides `POST`.
 ## Features/Problems
 
 * Appears to actually work. A good feature to have.
-* Encapsulates posting of file/binary parts and name/value parameter parts, similar to 
+* Encapsulates posting of file/binary parts and name/value parameter parts, similar to
   most browsers' file upload forms.
 * Provides an `UploadIO` helper class to prepare IO objects for inclusion in the params
   hash of the multipart post object.
 
 ## Installation
 
-    gem install multipart-post 
-    
+    gem install multipart-post
+
 or in your Gemfile
 
     gem 'multipart-post'
@@ -51,7 +51,7 @@ res = Net::HTTP.start(url.host, url.port) do |http|
 end
 ```
 
-To post files with other normal, non-file params such as input values, you need to pass hashes to the `Multipart.new` method. 
+To post files with other normal, non-file params such as input values, you need to pass hashes to the `Multipart.new` method.
 
 In Rails 4 for example: