Skip to content

Commit

Permalink
Document project
Browse files Browse the repository at this point in the history
  • Loading branch information
Olivier Balais committed Aug 23, 2016
1 parent debb497 commit 5263778
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Docker scss-lint

## What is scss-lint

`scss-lint` is a tool to help keep your [SCSS](http://sass-lang.com) files
clean and readable by running it against a collection of
configurable [linter rules](lib/scss_lint/linter/README.md). You can run it
manually from the command line, or integrate it into your
[SCM hooks](https://github.com/brigade/overcommit).

You can get more informations at: [https://github.com/brigade/scss-lint](https://github.com/brigade/scss-lint).

## Run using Docker

```sh
docker run --rm -v $(pwd):/app rvip/scss-lint
```

You can pass in every options scss-lint accepts:

```sh
docker run --rm -v $(pwd):/app rvip/scss-lint src/
```

For the full list of options, go to [scss-lint official README](https://github.com/brigade/scss-lint#usage).

## Build

```sh
git clone https://github.com/ReputationVIP/docker-scss-lint.git && cd docker-scss-lint
docker build -t your-namespace/scss-lint .
```

0 comments on commit 5263778

Please sign in to comment.