README.md in contact_us-0.4.0 vs README.md in contact_us-0.5.0
- old
+ new
@@ -1,6 +1,6 @@
-# Contact Us [](http://travis-ci.org/jdutil/contact_us) [](https://gemnasium.com/jdutil/contact_us) [][pledgie]
+# Contact Us [](http://travis-ci.org/jdutil/contact_us) [](https://gemnasium.com/jdutil/contact_us) [][pledgie]
A Rails 3+ Engine providing a basic contact form.
[travis]: http://travis-ci.org/jdutil/contact_us
[gemnasium]: https://gemnasium.com/jdutil/contact_us
[pledgie]: http://www.pledgie.com/campaigns/16807
@@ -12,85 +12,114 @@
## REQUIREMENTS
Contact Us requires:
-* Ruby >= 1.8.7 (will soon only support > 1.9.2)
+* Ruby >= 1.9.3
* Rails >= 3.0.0
It is also recommended to use Formtastic or SimpleForm (see configuration) in order to hook into your apps custom form builders.
## INSTALLATION
In your `Gemfile`, add the following dependencies:
- gem 'contact_us', '~> 0.4.0'
+```ruby
+gem 'contact_us', '~> 0.4.0'
+```
-From `Rails.root` run:
+From `Rails.root` in your Terminal run:
- $ bundle
- $ bundle exec rake contact_us:install
+```shell
+bundle
+bundle exec rake contact_us:install
+```
In `config/initializers/contact_us.rb` modify:
- config.mailer_to = "contact@please-change-me.com"
+```ruby
+config.mailer_to = "contact@please-change-me.com"
+```
Change to the email address you would like to receive the form submissions at for example:
- config.mailer_to = "contact@yourdomain.com"
+```ruby
+config.mailer_to = "contact@yourdomain.com"
+```
By default the emails from field will be the email entered by the user to easily reply, but this may not be allowed if your required to verify your sending email addresses.
You may also specify an email address for the notification emails from field:
- config.mailer_from = "dontreply@yourdomain.com"
+```ruby
+config.mailer_from = "dontreply@yourdomain.com"
+```
## CONFIGURATION
If you would like to add a name or subject field to the form you may simply
set the options to true within the contact_us initializer located at `config/initializers/contact_us.rb`:
- config.require_name = true
- config.require_subject = true
+```ruby
+config.require_name = true
+config.require_subject = true
+```
+To redirect to a specific URL after a successful form submission:
+```ruby
+config.success_redirect = '/contact-success'
+```
+
### Views
To copy the view files to `app/views/contact_us`, and customize them to suit your needs run:
- bundle exec rake contact_us:copy_views
+```shell
+bundle exec rake contact_us:copy_views
+```
### Locales
To copy the locale files to `config/locales/contact_us.*.yml`, and customize them to suit your needs run:
- bundle exec rake contact_us:copy_locales
+```shell
+bundle exec rake contact_us:copy_locales
+```
Please feel free to submit your own locales so that other users will hopefully find this gem more useful in your language.
### Formtastic
In order to use a Formtastic compatible template to hook into your custom form styles configure `config/initializers/contact_us.rb`:
- config.form_gem = 'formtastic'
+```ruby
+config.form_gem = 'formtastic'
+```
* By default the HTML should match that produced by Formtastic, but to ensure it is up to date you should set Formtastic.
### SimpleForm
In order to use a SimpleForm compatible template to hook into your custom form styles configure `config/initializers/contact_us.rb`:
- config.form_gem = 'simple_form'
+```ruby
+config.form_gem = 'simple_form'
+```
## UPGRADING
When upgrading from 0.1.x to 0.2.x you should rerun the install generator to install the new settings, views, and locale updates:
- $ bundle exec rake contact_us:install
+```shell
+bundle exec rake contact_us:install
+```
Or you may run the generators for each specific component you would like to update, which is quite useful when upgrading during patch releases for example from 0.2.0 to 0.2.1:
- $ bundle exec rake contact_us:copy_locales
- $ bundle exec rake contact_us:copy_views
+```shell
+bundle exec rake contact_us:copy_locales
+bundle exec rake contact_us:copy_views
+```
## USAGE
Visit your website and navigate to `/contact-us` to see the form in action.
@@ -102,10 +131,22 @@
## ISSUES
Please report any bugs or feature requests to the Github issues page @ https://github.com/jdutil/contact_us/issues
+## TESTING
+
+In order to run the spec suite:
+
+```shell
+bundle exec rspec spec
+```
+
+## TODO
+
+* Add new language translations.
+
## CONTRIBUTING
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:
@@ -119,10 +160,10 @@
* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
* by refactoring code
* by resolving [issues](https://github.com/jdutil/contact_us/issues)
* by reviewing patches
-## TODO
+## Donating
-* Add new language translations.
+Bitcoin donations may be sent to: 1Jz1rWG6HSWb6eBGgTyhANrkVxmzY4YPKS
-Copyright (c) 2011 Jeff Dutil, released under the [MIT license](https://github.com/jdutil/contact_us/tree/master/MIT-LICENSE).
+Copyright (c) 2011-2013 Jeff Dutil, released under the [MIT license](https://github.com/jdutil/contact_us/tree/master/MIT-LICENSE).