Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Updated README with lotus usage instructions and running tests.
  • Loading branch information
manuwell committed Aug 5, 2015
1 parent 55707ee commit 3f3ebc8
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Expand Up @@ -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.
Expand Down Expand Up @@ -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)
Expand Down

0 comments on commit 3f3ebc8

Please sign in to comment.