PG::Doc

Gem Version Build Status Dependency Status

This gem is under initial development. 0.1.0 will be the first release.

Installation

Add this line to your application's Gemfile:

gem 'pg-doc'

And then execute:

$ bundle

Or install it yourself as:

$ gem install pg-doc

To Do

  • [ ] Document usage
  • [ ] Document mount PG::Doc::Web(url, options)
  • [ ] Document :schema_filter option
  • [ ] Create and document caching to disk via marshal
  • [ ] Create and document the markdown folder structure
  • [ ] Write UI

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kenaniah/pg-doc.