Commit 193c0fbf authored by Brice Sanchez's avatar Brice Sanchez Committed by Brice Sanchez
Browse files

Update readme infos [ci skip]

parent e47b6473
......@@ -14,11 +14,20 @@ Refinery CMS Acts As Indexed is the [Acts As Indexed](https://github.com/dougal/
Open up your ``Gemfile`` and add at the bottom this line:
```ruby
gem 'refinerycms-acts-as-indexed', '~> 2.0.1'
gem 'refinerycms-acts-as-indexed', '~> 3.0.0'
```
Now run `bundle install`.
## Upgrade
When upgrading to a new version of `refinerycms-acts-as-indexed` it is recommended you delete the index directory and allow it to be rebuilt.
## Contribute
Please see the [contributing.md](contributing.md) file for instructions.
## More Information
* Check out our [Website](http://refinerycms.com/)
* [Help and documentation](https://github.com/refinery/refinerycms#help-and-documentation)
* [Help and documentation](https://github.com/refinery/refinerycms#help-and-documentation)
\ No newline at end of file
# Contribution Guidelines #
## Submitting a new issue ##
If you want to ensure that your issue gets fixed *fast* you should
attempt to reproduce the issue in an isolated example application that
you can share.
## Running tests ##
Always run tests first. Quick start for tests (requires a dummy application) :
bundle install
bundle exec rake refinery:testing:dummy_app
bundle exec rake
## Making a pull request ##
If you'd like to submit a pull request please adhere to the following:
1. Your code *must* be tested. Please TDD your code!
2. No single-character variables.
3. Two-spaces instead of tabs.
4. Double-quoted strings are fine for all use cases.
5. General Rails/Ruby naming conventions for files and classes.
6. Please add `[ci skip]` to your commit message for purely documentation changes **only**.
Please note that you must adhere to each of the above mentioned rules.
Failure to do so will result in an immediate closing of the pull
request. If you update and rebase the pull request to follow the
guidelines your pull request will be re-opened and considered for
inclusion.
## Links ##
See also the [Contributing to Refinery](http://refinerycms.com/guides/contributing-to-refinery) guide.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment