Skip to content

Added a little more setup detail to README. #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
karlwilbur wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added a little more setup detail to README. #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ A guard to lint your SCSS.

## Installation

### With Bundler
Add this line to your application's Gemfile:

gem 'guard-scss-lint'
Expand All @@ -12,13 +13,24 @@ And then execute:

$ bundle

Or install it yourself as:
### Without Bundler
Install with:

$ gem install guard-scss-lint

### Updating Guardfile
Add a basic setup to your Guardfile with:

guard init scss-lint

## Usage

TODO: Write usage instructions here
Please read the [Guard usage documentation][gdoc].

## Guardfile

guard-sass can be adapted to all kind of projects. Please read the
[Guard documentation][gdoc] for more information about the Guardfile DSL.

## Contributing

Expand Down