README.md in gindex-0.2.0 vs README.md in gindex-0.3.0
- old
+ new
@@ -1,52 +1,60 @@
# g index
:speedboat: Instant **concurrent** index migrations for Rails
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem "gindex", group: :development
+```
+
+## How It Works
+
```sh
rails g index users email
```
generates:
```ruby
-class AddIndexOnEmailToUsers < ActiveRecord::Migration[6.0]
+class AddIndexOnEmailToUsers < ActiveRecord::Migration[6.1]
disable_ddl_transaction!
def change
- add_index :users, [:email], algorithm: :concurrently
+ add_index :users, :email, algorithm: :concurrently
end
end
```
Also works with multi-column indexes
```sh
rails g index deliveries store_id delivered_at
```
-## Installation
-
-Add this line to your application’s Gemfile:
-
-```ruby
-gem 'gindex', group: :development
-```
-
-And then execute:
-
-```sh
-bundle
-```
-
## TODO
- add `:name` option to long index names
+## History
+
+View the [changelog](https://github.com/ankane/gindex/blob/master/CHANGELOG.md)
+
## Contributing
Everyone is encouraged to help improve this project. Here are a few ways you can help:
- [Report bugs](https://github.com/ankane/gindex/issues)
- Fix bugs and [submit pull requests](https://github.com/ankane/gindex/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/gindex.git
+cd gindex
+bundle install
+```