README.md in pg-doc-0.0.0 vs README.md in pg-doc-0.0.1
- old
+ new
@@ -1,10 +1,12 @@
# PG::Doc
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pg/doc`. To experiment with that code, run `bin/console` for an interactive prompt.
+[](http://badge.fury.io/rb/pg-doc)
+[](http://travis-ci.org/kenaniah/pg-doc)
+[](https://gemnasium.com/kenaniah/pg-doc)
-TODO: Delete this and the text above, and describe your gem
+**This gem is under initial development. 0.1.0 will be the first release.**
## Installation
Add this line to your application's Gemfile:
@@ -18,18 +20,17 @@
Or install it yourself as:
$ gem install pg-doc
-## Usage
+## To Do
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+ - [ ] 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.