Update README with more informations and fewer WARNINGS [ci skip]

bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

readme.md

@@ -1,27 +1,57 @@
-# Portfolio plugin for [Refinery CMS](http://www.refinerycms.com) ([GitHub](http://github.com/refinery/refinerycms))
+# Refinery CMS Portfolio
 
-## WARNING!
+[![Build Status](https://travis-ci.org/refinery/refinerycms-portfolio.svg?branch=master)](https://travis-ci.org/refinery/refinerycms-portfolio)
 
-This latest version (master) is not stable and the schema may actively change. Use at your own risk.
-If you are looking for a Refinery 2.0-compatible branch, use the '2-0-stable' branch.
+Simple portfolio engine for [Refinery CMS](http://refinerycms.com).
 
-## Requirements
+This version of `refinerycms-portfolio` supports Refinery 3.x and Rails 4.2.x. To use Rails 3.x / Refinery 2.1.x use the [refinerycms-portfolio "Refinery CMS 2-1 stable branch"](http://github.com/refinery/refinerycms-portfolio/tree/2-1-stable).
 
-This engine requires Refinery CMS version >= 3.0.0.dev.
+## Requirements
 
-## Gem Installation
+Refinery CMS version 3.0.0 or above.
 
-Ensure you have created your application's database before adding this engine (with `rake db:setup`).
+## Install
 
-Open your `Gemfile` and add this line to the bottom:
+Open up your ``Gemfile`` and add at the bottom this line:
 
 ```ruby
 gem 'refinerycms-portfolio', github: 'refinery/refinerycms-portfolio', branch: 'master'
 ```
 
 Now run `bundle install` and once bundler has installed the gem run:
 
-    rails generate refinery:portfolio
-    rake db:migrate db:seed
+Next, to install the portfolio plugin run:
+
+    $ rails generate refinery:portfolio
+
+Run database migrations:
+
+    $ bundle exec rake  db:migrate
+
+Finally seed your database and you're done.
+
+    $ bundle exec rake  db:seed
+
+## Developing & Contributing
+
+The version of Refinery to develop this engine against is defined in the gemspec. To override the version of refinery to develop against, edit the project Gemfile to point to a local path containing a clone of refinerycms.
+
+### Testing
+
+Generate the dummy application to test against
+
+    $ bundle exec rake refinery:testing:dummy_app
+
+Run the test suite with [Guard](https://github.com/guard/guard)
+
+    $ bundle exec guard start
+
+Or just with rake spec
+
+    $ bundle exec rake spec
 
-Now, restart your web server and enjoy.
+## More Information
+* Check out our [Website](http://refinerycms.com/)
+* Documentation is available in the [guides](http://refinerycms.com/guides)
+* Questions can be asked on our [Google Group](http://group.refinerycms.org)
+* Questions can also be asked in our IRC room, [#refinerycms on freenode](irc://irc.freenode.net/refinerycms)