Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
13 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,35 @@ | ||
= JSON Schema Builder | ||
# JSON Schema Builder | ||
|
||
{<img src="https://secure.travis-ci.org/salesking/json_schema_builder.png?branch=master" alt="Build Status" />}[http://travis-ci.org/salesking/json_schema_builder] | ||
[![Build Status](https://travis-ci.org/salesking/json_schema_builder.svg)](https://travis-ci.org/salesking/json_schema_builder) | ||
|
||
Build a JSON schema for your ActiveRecord models. STOP your API pains! | ||
|
||
The created schema.json files are meant as stubs and need to be enriched with | ||
field descriptions and names. You might also want to remove or add object | ||
properties, since the gem only uses the available ActiveRecord database fields. | ||
|
||
== Usage | ||
## Usage | ||
|
||
Hook the gem into your rails app and create the schema files. | ||
|
||
gem 'json_schema_builder' | ||
|
||
rake schema:build | ||
|
||
Your Models and their fields are written into JSON files which you can | ||
pimp further. | ||
|
||
== Test | ||
## Supports | ||
|
||
* ruby 1.9, 2.2 | ||
* active_record > 4 (use gem version < 0.1.0 for older versions) | ||
|
||
## Test | ||
|
||
bundle install | ||
bundle exec rake spec | ||
|
||
## Contribute | ||
|
||
Feel free to fork and add features or fixes for other ActiveRecord versions | ||
|
||
Copyright Georg Leciejewski, MIT License |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
module SchemaBuilder | ||
VERSION = "0.0.6" | ||
VERSION = "0.1.0" | ||
end |