README.md in octopress-docs-0.0.3 vs README.md in octopress-docs-0.0.4
- old
+ new
@@ -1,6 +1,6 @@
-# Octopress::Docs
+# Octopress Docs
TODO: Write a gem description
## Installation
@@ -16,10 +16,21 @@
$ gem install octopress-docs
## Usage
-TODO: Write usage instructions here
+Automatically add your Readme and Changelog files:
+
+```ruby
+begin
+ require 'octopress-docs'
+ Octopress::Docs.add({
+ name: "Your Plugin",
+ dir: File.expand_path(File.join(File.dirname(__FILE__), "../../")),
+ })
+rescue
+end
+```
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)