Skip to content

Commit

Permalink
Merge pull request #14 from eishis/fix-README
Browse files Browse the repository at this point in the history
Add description to README
  • Loading branch information
eishisaito committed Sep 6, 2018
2 parents 3f4f78e + 5900d25 commit c48a497
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,18 @@ To generate a configuration file(config/initializers/schemate.rb), to set defaul

$ rails g schemate:install

Edit this file to control auto generation, and output format.

By default, schema is exported only when you run `schemate:export_csv` or `schemate:export_md`.
If you want to export schema as markdown automatically with `rake db:migrate`, edit the file and change:
If you want to export schema automatically with `rake db:migrate`, edit the file and change:

config.auto_generate = true

By default, auto generate file type is markdown.
If you want to generate file as csv, edit the file and change:

config.auto_generate_type = 'csv'

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/eishis/schemate. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
Expand Down

0 comments on commit c48a497

Please sign in to comment.