Skip to content

Commit

Permalink
update readme, bump v0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
schorsch committed Jan 12, 2016
1 parent 8483874 commit 95b2c47
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
17 changes: 12 additions & 5 deletions README.rdoc → README.md
@@ -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
2 changes: 1 addition & 1 deletion lib/schema_builder/version.rb
@@ -1,3 +1,3 @@
module SchemaBuilder
VERSION = "0.0.6"
VERSION = "0.1.0"
end

0 comments on commit 95b2c47

Please sign in to comment.