README.md in mail_manager-3.2.0 vs README.md in mail_manager-3.2.1

- old
+ new

@@ -3,106 +3,69 @@ The goal of this project will be to create a plugin for use in any site which will provide an interface to manage mailing lists, scheduling of email mailings, subscribe/unsubscribe from lists by contacts, and view reports of bounces and possible track views of emails. Currently, only one list is supported for subscribe/unsubscribe by contact. An interface is available to provide mailable objects from other plugins. Requirements ------------ -* Rails 3.2.x -* Ruby 1.9.3-x +* Rails 3.2.x (currently tested with rails 3.2.21) +* Ruby 2.1.5 (currently tested with 2.1.5, we have tested against 1.9.3, but ruby devs no longer support it) * [Bundler](http://bundler.io) * [Delayed::Job](https://github.com/collectiveidea/delayed_job/) - (currently the only queue job runnerwe support) Optional Dependencies --------------------- * [RVM](http://rvm.io) - How we control our ruby environment(mainly concerns development) +* currently we use github/git for our repository Installation ------------ Using bundler, edit your Gemfile.. add a one of the following lines: - +```ruby gem 'mail_manager', '~>3' # this points to the latest rails stable 3.2.x version - # OR + # OR gem 'mail_manager', git: 'https://github.com/LoneStarInternet/mail_manager.git', branch: 'rails3.2.x' # for the bleeding edge rails 3.2.x version - +``` Then run bundle install: - +``` bundle install - -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) - +``` +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] - +``` 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 +``` **NOTE:** you need to create an email account that will receive bounces from your mailings(and allow POP)... configure in the following file: Add your routes to config/routes.rb (you can say where with at: '/path') - +```ruby mount MailManager::Engine, at: '/admin/mail_manager' +``` config/mail_manager.yml ----------------------- This is where amost all of your configuration options are for this gem... current generator will add documentation to it (preserving your current settings) .. we'll probably want to upgrade to something like: [AppConfig](https://github.com/Oshuma/app_config) gem -You can generate this file like above(where table_prefix is for prefixing table names): +You can generate this file like above(where table_prefix is for prefixing table names): +``` rake mail_manager:default_app_config[table_prefix] +``` +* This generator adds settings documentation to the yml file +* You can override values with a config/mail_manager.local.yml +* For a full description [See the wiki](https://github.com/LoneStarInternet/mail_manager/wiki/config-mail_manager.yml) -You can override values with a config/mail_manager.local.yml - Securing your App ----------------- We implemented [CanCan](https://github.com/CanCanCommunity/cancancan). If you'd like to secure your actions to certain users and don't currently have any authorization in your app, you can follow the following steps if you want an easy config.. or you could make it more finely grained.. currently its all or nothing: +[See the wiki](https://github.com/LoneStarInternet/mail_manager/wiki/Securing-your-app) -If you don't have an app/models/ability.rb(i.e. you don't currently use cancan): - - rails g cancan:ability - -Next add the mail manager abilities to your file (which should look something like this): - - class Ability - include CanCan::Ability - - def initialize(user) - eval MailManager.abilities # this is what you ADD - end - - end - -Next decide whether they just need to log in ... or if they should have a role - -If they need to at least log in, set the following in their config/mail_manager.yml: - - requires_authentication: true - -If they need a certain role, the following in their config/mail_manager.yml: - - authorized_roles: - - admin - -If you're using roles, User must either respond to 'roles' or 'role' or you can configure a custom role method on your model and configure it in mail_manager.yml like so: - - roles_method: my_role_names - Development ----------- If you wish to contribute, you should follow these instructions to get up and running: - -Clone the repository: - - git clone https://github.com/LoneStarInternet/mail_manager.git - -Checkout the rails3.2.x branch: - - cd mail_manager - git checkout rails3.2.x - -Set up your database(currently mysql and sqlite are supported); you can get an example db file by copying one of the examples: - - cd spec/test_app - cp config/database.mysql.yml config/database.yml # for mysql - cp config/database.sqlite.yml config/database.yml # for sqlite +[See the wiki](https://github.com/LoneStarInternet/mail_manager/wiki/Contributing)