README.md in jekyll_pages_api-0.1.2 vs README.md in jekyll_pages_api-0.1.3
- old
+ new
@@ -1,10 +1,10 @@
# Jekyll Pages API [](https://travis-ci.org/18F/jekyll_pages_api) [](https://codeclimate.com/github/18F/jekyll_pages_api)
[](https://gitter.im/18F/jekyll_pages_api?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-Jekyll Pages API is a [Jekyll Plugin](http://jekyllrb.com/docs/plugins/) gem that generates a JSON file with data for all the Pages in your Site. [Jekyll](http://jekyllrb.com), if you're not familiar, is a static website generator written in Ruby.
+Jekyll Pages API is a [Jekyll Plugin](http://jekyllrb.com/docs/plugins/) gem that generates a JSON file with data for all the Pages, Posts, Documents (i.e. "collections") and StaticFiles in your Site. [Jekyll](http://jekyllrb.com), if you're not familiar, is a static website generator written in Ruby.
## Usage
Add this line to your application's Gemfile:
@@ -37,9 +37,28 @@
]
}
```
This endpoint will be re-generated any time your site is rebuilt.
+
+## Developing
+
+* Run `bundle` to install any necessary gems.
+* Run `bundle exec rake -T` to get a list of build commands and descriptions.
+* Run `bundle exec rake spec` to run the tests.
+* Run `bundle exec rake build` to ensure the entire gem can build.
+* Commit an update to bump the version number of
+ `lib/jekyll_pages_api/version.rb` before running `bundle exec rake release`.
+
+While developing this gem, add this to the Gemfile of any project using the
+gem to try out your changes (presuming the project's working directory is a
+sibling of the gem's working directory):
+
+```ruby
+group :jekyll_plugins do
+ gem 'jekyll_pages_api', :path => '../jekyll_pages_api'
+end
+```
## See also
Additional means of turning your site content into data: