Skip to content

Commit

Permalink
Merge pull request railsadminteam#1030 from ysiadf/patch-1
Browse files Browse the repository at this point in the history
(Docs) Update README.md with minor grammatical fixes. [ci skip]
  • Loading branch information
bbenezech committed Mar 11, 2012
2 parents d0aea5e + 47de6c6 commit 51b17d9
Showing 1 changed file with 21 additions and 16 deletions.
37 changes: 21 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Old outdated translations have been removed, you must now fetch them from the wi

See [Wiki](https://github.com/sferik/rails_admin/wiki/Translations) for more informations.

Thanks a lot to all the translators sharing their work, sorry for the added worked (it was really needed).
Thanks a lot to all the translators sharing their work, sorry for the added work (it was really needed).

* History

Expand All @@ -63,7 +63,8 @@ If you wish to continue using the old history feature, please add this to your i
config.audit_with :history, User
```

Alternatively, [PaperTrail](https://github.com/airblade/paper_trail) is now officially compatible. Install it, add `has_paper_trail` to the models you wish to track, and add this instead to your initializer:
Alternatively, [PaperTrail](https://github.com/airblade/paper_trail) is now officially compatible.
Install it, add `has_paper_trail` to the models you wish to track, and add the following code to your initializer:

```ruby
config.audit_with :paper_trail, User
Expand Down Expand Up @@ -119,9 +120,10 @@ It will modify your `config/routes.rb`, adding:
mount RailsAdmin::Engine => '/admin', :as => 'rails_admin' # Feel free to change '/admin' to any namespace you need.
```

It will add an intializer that will help you getting started. (head for config/initializers/rails_admin.rb)
It will also add an intializer that will help you getting started. (head for config/initializers/rails_admin.rb)

Optionaly, you may want to set up [Cancan](https://github.com/ryanb/cancan), [PaperTrail](https://github.com/airblade/paper_trail), [CKeditor](https://github.com/galetahub/ckeditor)
Optionally, you may wish to set up [Cancan](https://github.com/ryanb/cancan),
[PaperTrail](https://github.com/airblade/paper_trail), [CKeditor](https://github.com/galetahub/ckeditor)

More on that in the [Wiki](https://github.com/sferik/rails_admin/wiki)

Expand All @@ -138,21 +140,23 @@ You should now be able to administer your site at
All configuration documentation has moved to the wiki: https://github.com/sferik/rails_admin/wiki

## <a name="support"></a>Support
Please see [list of know issues](https://github.com/sferik/rails_admin/wiki/Known-issues) first.
Please see [list of known issues](https://github.com/sferik/rails_admin/wiki/Known-issues) first.

If you have a question, you can ask the [official RailsAdmin mailing
If you have a question, please check this README, the wiki, and the list of known issues.

If you still have a question, you can ask the [official RailsAdmin mailing
list](http://groups.google.com/group/rails_admin) or ping sferik on IRC in
[#railsadmin on
irc.freenode.net](http://webchat.freenode.net/?channels=railsadmin).

Check this README and the wiki first.

If you think you found a bug in RailsAdmin, you can [submit an
issue](https://github.com/sferik/rails_admin#issues)
No feature requests or questions please (the mailing list is active).
issue](https://github.com/sferik/rails_admin#issues).
No feature requests or questions please (the mailing list is
active and is the preferred venue for feature requests and questions).

## <a name="contributing"></a>Contributing
In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html),
**everyone** is encouraged to help improve this project.

Here are some ways *you* can contribute:

Expand All @@ -170,7 +174,7 @@ Here are some ways *you* can contribute:

## <a name="issues"></a>Submitting an Issue
We use the [GitHub issue tracker](https://github.com/sferik/rails_admin/issues) to track bugs and
features. Before submitting a bug report or feature request, check to make sure it hasn't already
features. Before submitting a bug report or feature request, please check to make sure it hasn't already
been submitted. You can indicate support for an existing issue by voting it up. When submitting a
bug report, please include a [Gist](https://gist.github.com/) that includes a stack trace and any
details that may be necessary to reproduce the bug, including your gem version, Ruby version, and
Expand All @@ -179,17 +183,18 @@ operating system. Ideally, a bug report should include a pull request with faili
## <a name="pulls"></a>Submitting a Pull Request
1. Fork the project.
2. Create a topic branch.
3. Implement your feature or bug fix. *NOTE* - there's a small test app located in the spec/dummy_app directory that you can use to experiment with rails_admin.
3. Implement your feature or bug fix. *NOTE* - there's a small test app located in the
spec/dummy_app directory that you can use to experiment with rails_admin.
4. Add documentation for your feature or bug fix.
5. Run `bundle exec rake doc:yard`. If your changes are not 100% documented, go back to step 4.
6. Add specs for your feature or bug fix.
7. Run `bundle exec rake spec`. If your changes are not 100% covered, go back to step 6.
8. Commit and push your changes.
9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
9. Submit a pull request. Please do not include changes to the gemspec, version, or history file.
(If you want to create your own version for some reason, please do so in a separate commit.)

## <a name="versions"></a>Supported Ruby Versions
This library aims to support and is [tested against][travis] the following Ruby
implementations:
This library aims to support and is [tested against][travis] the following Ruby implementations:

* Ruby 1.8.7
* Ruby 1.9.2
Expand Down

0 comments on commit 51b17d9

Please sign in to comment.