README.md in pah-0.0.13 vs README.md in pah-0.0.14
- old
+ new
@@ -1,51 +1,54 @@
-# Pah
+# PAH
+[![Build Status][travis_badge]][travis]
[![RubyGems][gem_version_badge]][ruby_gems]
[![Code Climate][code_climate_badge]][code_climate]
[![Gemnasium][gemnasium_badge]][gemnasium]
-A rails application template which was born from [Startup DEV][startupdev] and now is used to start most projects at [HE:labs][helabs].
+A Rails application template which was born from [Startup DEV][startupdev] and now is used to start most projects at [HE:labs][helabs].
+## Dependencies
+
+* Heroku Toolbelt - https://toolbelt.heroku.com/
+* phantomjs - http://phantomjs.org/download.html
+
## Instalation
-Install Pah at the command prompt:
+Install PAH with the command:
- gem install pah
+```bash
+$ gem install pah
+```
-If using [RVM see this tips](https://github.com/Helabs/pah/wiki/Using-Pah-with-RVM).
+If you're using [RVM see those tips](https://github.com/Helabs/pah/wiki/Using-Pah-with-RVM).
## Usage
Run:
- pah projectname
+```bash
+$ pah projectname
+```
-This will create a Rails 4.0 app in `projectname` with ruby 2.1.1. This script creates a new git repository. It is not meant to be used against an existing repo.
+This will create a Rails 4.1.1 with Ruby 2.1.2. This script creates a new git repository in the folder `projectname`.
+:warning: PAH not meant to be used against an existing repo.
+
### RVM
-If using the rvm is recomended before using pah, create and use a gemset, with the project name.
+If you're using RVM, create and use a gemset (with the project name) before running PAH:
```bash
-$ rvm use 2.1.1@projectname --create
+$ rvm use 2.1.2@projectname --create
+$ pah projectname
```
-Pah automatically create the .ruby-version and .ruby-gemset files.
+PAH automatically create the .ruby-version and .ruby-gemset files.
-## Dependencies
-
-### heroku toolbelt
-
-Install from: https://toolbelt.heroku.com/
-
-### phantomjs
-
-Install from: http://phantomjs.org/download.html
-
## Versioning
-Pah follow the [Semantic Versioning](http://semver.org/).
+PAH follows the [Semantic Versioning](http://semver.org/) standard.
## Issues
If you have problems, please create a [Github Issue](https://github.com/Helabs/pah/issues).
@@ -54,31 +57,44 @@
Please see [CONTRIBUTING.md](https://github.com/Helabs/pah/blob/master/CONTRIBUTING.md) for details.
## Maintainers
- [Mauro George](https://github.com/maurogeorge)
+- [Thiago Belem](https://github.com/TiuTalk)
+## Roadmap
+
+- Improve the specs and test coverage
+- Refactor the templates/partials logic
+- Extract "utils" to somewhere else outside the template.rb
+- Make sure all the generated files are not beign overriden with older versions (like spec_helper, applications config & etc), don't copy files.. build them
+- Remove all the default CSS/views/controllers that are not necessary for a new project
+- Remove the old and unused spec/support files
+- Release version 1.0
+
## Release
Follow this steps to release a new version of the gem.
1. Test if everything is running ok;
-1. Change version of the gem on `VERSION` constant;
-1. Add the release date on the `CHANGELOG`;
-1. Do a commit "Bump version x.x.x", follow the semantic version;
-1. Run `$ rake release`, this will send the gem to the rubygems;
-1. Check if the gem is on the rubygems and the tags are correct on the github;
+2. Change version of the gem on `VERSION` constant;
+3. Add the release date on the `CHANGELOG`;
+4. Do a commit "Bump version x.x.x", follow the semantic version;
+5. Run `$ rake release`, this will send the gem to the rubygems;
+6. Check if the gem is on the rubygems and the tags are correct on the github;
-## Credits
+## Made with love by HE:labs
-Pah is maintained and funded by [HE:labs](http://helabs.com.br/opensource/).
-Thank you to all the [contributors](https://github.com/Helabs/pah/graphs/contributors).
+![HE:labs](http://helabs.com.br/images/logo.png)
+This gem was created and is maintained by [HE:labs](https://github.com/Helabs).
+
[startupdev]: http://startupdev.com.br
[helabs]: http://helabs.com.br
[gem_version_badge]: https://badge.fury.io/rb/pah.png
[ruby_gems]: http://rubygems.org/gems/pah
[code_climate]: https://codeclimate.com/github/Helabs/pah
[code_climate_badge]: https://codeclimate.com/github/Helabs/pah.png
[gemnasium]: https://gemnasium.com/Helabs/pah
[gemnasium_badge]: https://gemnasium.com/Helabs/pah.png
-
+[travis]: https://travis-ci.org/Helabs/pah
+[travis_badge]: https://travis-ci.org/Helabs/pah.svg?branch=master