README.md in i_reach-0.0.2 vs README.md in i_reach-0.1.0
- old
+ new
@@ -6,38 +6,59 @@
Requirements
------------
* Rails 3.2.x
* Ruby 1.9.3-x
+* [Bundler](http://bundler.io)
Optional Dependencies
---------------------
* [RVM](http://rvm.io)
-* [Bundler](http://bundler.io)
Installation
-----------
-* install rvm/ruby 1.9.3/bundler/rails 3.2.x then run the following or skip ahead to the next step if you already have a rails 3.2.x app
+* install rvm/ruby 1.9.3/bundler/rails 3.2.x then run the following or skip ahead to the next step if you already have a rails 3.2.x app
+ `# new rails app where you want to not use 'test' and want to use mysql
rails new MyApp -T --skip-bundle -d mysql
- cd MyApp
+ # or optionally a default rails app
+ rails new MyApp
+ cd MyApp`
-* edit your Gemfile
- gem 'i_reach'
+* edit your Gemfile
+ `gem 'i_reach'`
-* bundle your gems
- bundle install
+* bundle your gems
+ `bundle install`
* configure [mail_manager](https://github.com/LoneStarInternet/mail_manager/master/README.md)
-** generate migrations
- rake mail_manager:import_migrations
+ * generate migrations
+ `rake mail_manager:import_migrations`
-** generate delayed_jobs (this is the only job runner we support right now)
- rails g delayed_job:active_record
+ * generate delayed_jobs (this is the only job runner we support right now)
+ `rails g delayed_job:active_record`
-** configure your database(unless already configured) edit config/database.yml
+ * NOTE: you need to create an email account that will receive bounces from your mailings(and allow POP)... configure in the following file:
+ * generate and configure the mail manager settings file at config/mail_manager.yml: (replace table prefix with something... or nothing if you don't want to scope it)
+ `rake mail_manager:default_app_config[table_prefix]`
-** create(unless already created) and migrate the database
- rake db:create
- rake db:migrate
+* configure [newsletter](https://github.com/LoneStarInternet/newsletter/master/README.md)
+ * generate migrations
+ `rake newsletter:import_migrations`
-* mount IReach routes (you can say where by using at: /path)
- mount IReach::Engine
+ * generate and configure the newsletter settings file at config/newsletter.yml: (replace table prefix with something... or nothing if you don't want to scope it)
+ `rake newsletter:default_app_config[table_prefix]`
+
+* configure your database(unless already configured) edit config/database.yml
+
+* create(unless already created) and migrate the database
+ `rake db:create # this doesn't always work... you may need to use your normal client & set up permissions`
+ `rake db:migrate`
+
+* Create default admin menus for newsletter, mail_manager, and user administration
+ `rake newsletter:create_auth_menus
+ rake mail_manager:create_auth_menus`
+
+* create bounce job to check for emails that have bounced from your mailings
+ `rake mail_manager:create_delayed_jobs`
+
+* mount IReach routes (you can say where by using at: /path)
+ `mount IReach::Engine`