Sha256: abc071a3d153f823f6bdc7e7d184945765b063b58882a8c8716a8d216b17cee0

Contents?: true

Size: 929 Bytes

Versions: 4

Compression:

Stored size: 929 Bytes

Contents

# PG::Doc

[![Gem Version](https://badge.fury.io/rb/pg-doc.svg)](http://badge.fury.io/rb/pg-doc)
[![Build Status](https://travis-ci.org/kenaniah/pg-doc.svg?branch=master)](http://travis-ci.org/kenaniah/pg-doc)
[![Dependency Status](https://gemnasium.com/kenaniah/pg-doc.svg)](https://gemnasium.com/kenaniah/pg-doc)

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

## Installation

Add this line to your application's Gemfile:

```ruby
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.

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
pg-doc-0.0.4 README.md
pg-doc-0.0.3 README.md
pg-doc-0.0.2 README.md
pg-doc-0.0.1 README.md