diff --git a/README.md b/README.md index 94e6584..99225f7 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,12 @@ -# SyncNtnuPersonalData -Short description and motivation. - -## Usage -How to use my plugin. - -## Installation -Add this line to your application's Gemfile: - +# Usage +## at the target app, not this Orbit module(Rails Engine) +* create project\_root\/config\/initializers\/ntnu\_sybase\_config.rb with following content: ```ruby -gem 'sync_ntnu_personal_data' +ENV['USER_NAME'] = 'database user name' +ENV['PASSWORD'] = 'database password' +ENV['NTNU_DB_HOST'] = 'database host' +ENV['NTNU_DB_PORT'] = 'database port' +ENV['TDS_VERSION'] = '5.0' +ENV['DB_NAME'] = 'database name' ``` - -And then execute: -```bash -$ bundle -``` - -Or install it yourself as: -```bash -$ gem install sync_ntnu_personal_data -``` - -## Contributing -Contribution directions go here. - -## License -The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). +* set cron job to run `bundle exec rake sync_personal_plugins:sync` everyday