README.md in playmo-0.0.6 vs README.md in playmo-0.0.10
- old
+ new
@@ -1,55 +1,19 @@
-# Playmo
-This is the special kit that allows you create html5-ready Rails 3 apps quick with pre-included few useful libs in your app.
-It includes:
+# Playmo (under development)
+This is the special kit that allows you create html5-ready Rails 3.1 apps quick with pre-included few widely used libs in your app.
-* [Compass](http://compass-style.org/)
-* [Jammit](https://github.com/documentcloud/jammit) - industrial strength asset packaging for Rails
-* [HTML5 Boilerplate](http://html5boilerplate.com/)
-* [Mootools](http://mootools.net)
-* [Jquery](http://jquery.com)
-* [Devise](https://github.com/plataformatec/devise) - flexible authentication solution for Rails
-* [Cancan](https://github.com/ryanb/cancan) - authorization gem for Rails
-* [Capistrano](https://github.com/capistrano/capistrano) - remote multi-server automation tool
-* Set of useful rails helpers
+__Currently under development, so do not use it in production. Please wait for release.__
-*Don't forget that playmo supports only Rails 3 apps*
-
## How to install
-First, create new Rails 3 application
+First, install the gem:
- $ rails new appname
- $ cd ./appname
+ gem install playmo
-Then add to your Gemfile these lines
+After that, run playmo to generate new rails app:
- group :development do
- gem 'playmo', :git => 'git://github.com/tanraya/playmo.git'
- end
+ $ playmo myappname
-After that, run bundle to install necessary gems
+Then just answer a questions. That's all. Now you can run your app:
- $ bundle
-
-After installing the files we need to generate playmo files in our application
-
- $ rails g playmo:install
-
-That's all. Now you can run your app:
-
$ rails s
***
-
-## What it does (details)
-
-* Installs JQuery or Mootools depending on your preference
-* Replaces default layout with HTML5-Boilerplate
-* Generates HomeController with index action and view
-* Generates a set of useful helpers in ApplicationHelper
-* Removes default rails javascripts
-* Replaces prototype-ujs with jquery-ujs or mootools-ujs
-* Installs devise, cancan and compass (and their dependencies)
-* Adds _User.current_ class method as alias for devise _current_user_ helper, thus you access to current user object from other models.
-
-## Limitations
-Install the gem *only* into new empty app. Installation into ready apps is *only on your risk* because you may accidentally damage the files in your app.