README.md in faalis-1.0.0.alpha1 vs README.md in faalis-1.0.0.alpha2
- old
+ new
@@ -1,8 +1,10 @@
-# Faalis [![Gem Version](https://badge.fury.io/rb/faalis.png)](http://badge.fury.io/rb/faalis) [![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/Yellowen/Faalis?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+# Faalis
+[![Gem Version](https://badge.fury.io/rb/faalis.png)](http://badge.fury.io/rb/faalis)
+[![Build Status](https://travis-ci.org/Yellowen/Faalis.svg?branch=master)](https://travis-ci.org/Yellowen/Faalis)
+[![Downloads](https://img.shields.io/gem/dt/faalis.svg)](http://rubygems/gems/faalis)
-
**Faalis** is a **RubyOnRails** Platform for rapid web application development. It provides a very
robust dashboard subsystem with some fantastic generators and client side framework based on **AngularJS**
to improve productivity as much as possible.
@@ -31,11 +33,11 @@
gem "dashstrap"
gem "faalis"
```
-* Iinstall your project dependencies using `bundle`
+* Install your project dependencies using `bundle`
```ruby
bundle install
```
@@ -45,31 +47,31 @@
config.action_mailer.default_url_options = { :host => 'localhost:3000' }
```
> In production, `:host` should be set to the actual host of your application.
* Ensure you have flash messages in `app/views/layouts/application.html.erb`.
-For example (Only if you want to change default layout):
+For example (only if you want to change default layout):
```rhtml
<p class="notice"><%= notice %></p>
<p class="alert"><%= alert %></p>
```
-* Perfrom `rails generate faalis:install_all` to copy necessary files.
+* Perform `rails generate faalis:install_all` to copy necessary files.
* Add this to your `config/routes.rb` :
```ruby
mount Faalis::Engine => "/"
Faalis::Routes.define_api_routes
```
* Perform `rake db:migrate` and enjoy Faalis
-> **NOTE**: You change the orm you like to use in `config/initializers/faalis.rb`
+> **NOTE**: You can specify the ORM you'd like to use in `config/initializers/faalis.rb`
## Documents
-There is couple of guides along side with **Ruby** and **JavaScript** API 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).
@@ -79,17 +81,16 @@
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
-Also you can join us in our `Gitter` group:
-[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/Yellowen/Faalis?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+Also you can join us in our `IRC` channel: **#Faalis** on freenode. ( It will redirect you to #5hit :P )
## Credit
![Yellowen](http://www.yellowen.com/images/logo.png)
**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.
# License
-**Faalis** is Copyright © 2013-2014 Yellowen. It is free software, and may be redistributed under the terms specified in the LICENSE file.
+**Faalis** is Copyright © 2013-2015 Yellowen. It is free software, and may be redistributed under the terms specified in the LICENSE file.