README.md in tako-0.2.0 vs README.md in tako-0.2.1
- old
+ new
@@ -1,8 +1,10 @@
# Tako
+[![CircleCI](https://circleci.com/gh/the40san/tako/tree/master.svg?style=svg)](https://circleci.com/gh/the40san/tako/tree/master)
-Provides Horizontal-Sharding for ActiveRecord.
+Provides features for Database Sharding in ActiveRecord.
+The main goal of tako is implementing sharding features with less ActiveRecord-dependent, catching up Rails version up.
Rails 5 Ready.
## Installation
Add this line to your application's Gemfile:
@@ -17,10 +19,16 @@
Or install it yourself as:
$ gem install tako
+
+## Database migration (Rails)
+
+ $ bundle exec rake db:tako:create
+ $ bundle exec rake db:tako:migrate
+
## Usage
## How to use Tako?
First, you need to create a config file, shards.yml, inside your config/ directory.
Also you can override config file path with environment variable.
@@ -52,10 +60,14 @@
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
### Run test
Run `bundle exec rake` to run rspec
+
Run `bundle exec rake` in `spec/dummy5` will run rspec with rails 5
+
+Run `bundle exec rake` in `spec/dummy42` will run rspec with rails 4.2
+
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/the40san/tako. 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.