README.md in faalis-0.26.3 vs README.md in faalis-1.0.0.alpha0
- old
+ new
@@ -18,27 +18,56 @@
end
```
## Installation
-1. Add this to your `config/environments/development.rb`
+1. First add `faalis` to your `Gemfile` like
```ruby
+# Make sure to add this source to you Gemfile
+source 'http://rails-assets.org'
+
+gem "faalis"
+```
+**Note**: Make sure to add `source 'http://rails-assets.org'` to your `Gemfile`.
+
+2. Iinstall your project dependencies using `bundle`
+
+```ruby
+bundle install
+```
+
+3. Add this to your `config/environments/development.rb`
+
+```ruby
config.action_mailer.default_url_options = { :host => 'localhost:3000' }
```
-In production, :host should be set to the actual host of your application.
+In production, `:host` should be set to the actual host of your application.
-2. Ensure you have flash messages in app/views/layouts/application.html.erb.
+4. Ensure you have flash messages in `app/views/layouts/application.html.erb`.
For example (Only if you want to change default layout):
```rhtml
<p class="notice"><%= notice %></p>
<p class="alert"><%= alert %></p>
```
+5. Perfrom `rails generate faalis:install_all` to copy necessary files.
+6. Perform `rake db:migrate` and enjoy Faalis
+## Contributing
-3. Perfrom `rails generate faalis:install_all` to copy necessary files.
-4. Perform `rake db:migrate` and enjoy Faalis
+1. Fork it
+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
+## Credit
+
-[](https://bitdeli.com/free "Bitdeli Badge")
+**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 © 2014 Yellowen. It is free software, and may be redistributed under the terms specified in the LICENSE file.