README.md in octopress-docs-0.0.4 vs README.md in octopress-docs-0.0.5
- old
+ new
@@ -16,19 +16,20 @@
$ gem install octopress-docs
## Usage
-Automatically add your Readme and Changelog files:
+Automatically add your Readme and Changelog files along with any pages in your gem path under `/assets/docs`.
```ruby
begin
require 'octopress-docs'
Octopress::Docs.add({
name: "Your Plugin",
- dir: File.expand_path(File.join(File.dirname(__FILE__), "../../")),
+ slug: "your-plugin",
+ dir: File.expand_path(File.join(File.dirname(__FILE__), "../../"))
})
-rescue
+rescue LoadError
end
```
## Contributing