README.md

JSON:API

Documentation for the application/vnd.api+json media type, a specification for APIs that use JSON. This repository is the source code for http://jsonapi.org.

Resources

• IRC channel: #jsonapi on freenode.net
• Twitter: @jsonapi
• Discourse: http://discuss.jsonapi.org

Status

This standard is currently under development. To assist:

1. Get the dependencies:

   $ bundle

2. Host the site locally while editing:

   $ bundle exec rake preview:browser

3. Edit the Markdown files.

4. Commit your changes.

5. Send a Pull Request when finished.

The website is automatically built by GitHub Pages when changes are pushed to the gh-pages branch.

Archive

older versions of the JSON:API documentations

• RC3 - http://jsonapi-rc3.herokuapp.com/