README.md in faalis-2.0.0.rc2 vs README.md in faalis-2.0.0.rc3
- old
+ new
@@ -5,34 +5,34 @@
[](https://codeclimate.com/github/Yellowen/Faalis/coverage)
[](https://codeclimate.com/github/Yellowen/Faalis)
[](https://gemnasium.com/Yellowen/Faalis)
[](http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)
-**Faalis** is a **RubyOnRails** Platform for rapid web application development. It provides a very
-robust dashboard subsystem with some fantastic generators to improve productivity as much as possible.
+**Faalis** is well tuned platform to create web applications as fast as possible. It is built on top of other quality
+tools, and provides additional features like a robust dashboard, pre-baked authentication and authorization and other
+cool stuff.
-
## Installation
-Simply add `faalis` to your gem file like this:
+Simply add `faalis` to your gem file with following command:
```ruby
gem "faalis"
```
-Then install your project dependencies using `bundle`
+Then install your project dependencies using `bundle` command:
```bash
bundle install
```
-use `faalis:install` generator to install **faalis** into your project.
+use `faalis:install` generator to install **faalis** into your project by issuing the following command:
```bash
rails g faalis:install
```
-Add this to your `config/environments/development.rb`
+Add this to your `config/environments/development.rb` file
```ruby
config.action_mailer.default_url_options = { :host => 'localhost:3000' }
```
> In production, `:host` should be set to the actual host of your application.
@@ -40,15 +40,13 @@
Perform `rake db:migrate db:seed` and enjoy Faalis
> **NOTE**: You can specify the ORM you'd like to use in `config/initializers/faalis.rb`
## Documents
-There are a couple of guides along with **Ruby** and **JavaScript** API documents
-inside the source tree. We use `yardoc` so you can build them easily or look at automated [rubydoc](http://rubydoc.info/gems/faalis)
-docs.
-Also take a look at [Wiki of Faalis](https://github.com/Yellowen/Faalis/wiki).
+It's easier to starts with [Faalis Guides](http://guides.faalis.io/) but you can checkout the
+automated [rubydoc](http://rubydoc.info/gems/faalis) docs.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
@@ -59,10 +57,13 @@
Also you can join us in our `IRC` channel: **#Faalis** on freenode. ( It will redirect you to #5hit :P )
## Credit
-**Faalis** is maintained and funded by Yellowen. Whenever a code snippet is borrowed or inspired by existing code, we try to credit the original developer/designer in our source code. Let us know if you think we have missed to do this.
+**Faalis** is maintained and funded by Yellowen. Whenever a code snippet is borrowed or inspired by
+existing code, we try to credit the original developer/designer in our source code. Let us know if you
+think we have forgotten to do this, and we will do our best to locate the problem and fix it in a timely
+manner.
# License
**Faalis** is Copyright © 2013-2015 Yellowen. It is free software, and may be redistributed under the terms specified in the LICENSE file.