README.md in contact_us-0.1.5 vs README.md in contact_us-0.2.0
- old
+ new
@@ -1,10 +1,11 @@
-# Contact Us
-
+# 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.
-[](http://travis-ci.org/jdutil/contact_us)
+[travis]: http://travis-ci.org/jdutil/contact_us
+[gemnasium]: https://gemnasium.com/jdutil/contact_us
+[pledgie]: http://www.pledgie.com/campaigns/16807
There is also a demo application showing how the ContactUs form works:
* [View Demo Form In Action](http://contact-us-demo.heroku.com)
* [View Demo Applications Source Code](http://github.com/jdutil/contact_us_demo)
@@ -20,11 +21,11 @@
## INSTALLATION
In your `Gemfile`, add the following dependencies:
- gem 'contact_us', '~> 0.1.5'
+ gem 'contact_us', '~> 0.2.0'
From `Rails.root` run:
$ bundle
$ bundle exec rake contact_us:install
@@ -35,14 +36,34 @@
Change to the email address you would like to receive the form submissions at for example:
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"
+
+## 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
+
+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
+
## CONFIGURATION
-The generator copies the view files to `app/views/contact_us`, and you can customize them to suit your needs.
+The generator copies the view files to `app/views/contact_us`, and you can customize them to suit your needs. 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.name = true
+ config.subject = true
+
You may also update your locales under `config/locales/contact_us.en.yml` or create your own. Please feel free to submit your own locales so that other users will hopefully find this gem more useful.
## USAGE
Visit your website and navigate to `/contact_us` to see the form in action.
@@ -75,8 +96,7 @@
* by reviewing patches
## TODO
* Add new language translations
-* Make requested configurations in branches, and document how to reference within your Gemfile rather than the version. Configurations todo: with name, with subject, with name & subject
Copyright (c) 2011 Jeff Dutil, released under the [MIT license](https://github.com/jdutil/contact_us/tree/master/MIT-LICENSE).