From 3f3ebc8a1431ccc20a38a6e0e3f79f3c14252f15 Mon Sep 17 00:00:00 2001 From: Wellington Santos Date: Tue, 4 Aug 2015 17:54:06 -0300 Subject: [PATCH] Updated README with lotus usage instructions and running tests. --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index ecd79ac9..23d18e8d 100644 --- a/README.md +++ b/README.md @@ -119,6 +119,29 @@ View.new.render # => HTML markup For advanced configurations, please have a look at [`Lotus::Assets::Configuration`](https://github.com/lotus/assets/blob/master/lib/lotus/assets/configuration.rb). +### Lotus usage +For usage on `lotus` follow the instructions: + +- In your `apps/web/application.rb` include `lotus-assets` files: +```ruby +require 'lotus/assets' +require 'lotus/assets/helpers' +``` + +- In your `application_layout` just include the assets helpers +```ruby +module Web + module Views + class ApplicationLayout + include Admin::Layout + include Lotus::Assets::Helpers + end + end +end +``` + +- After that you will be able to use `javascript` and `stylesheet` in your template. + ### Development mode `Lotus::Assets` can help you during the development process of your application. @@ -218,6 +241,15 @@ public/ └── main.css ``` +## Running tests + +- Make sure you have one of [ExecJS](https://github.com/rails/execjs) +supported runtime on your machine. + +```sh +bundle exec rake test +``` + ## Versioning __Lotus::Assets__ uses [Semantic Versioning 2.0.0](http://semver.org)