Moduletrace/less-watcher
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Tben 2023-07-30 00:07:10 +01:00
parent 4ac3eb1239
commit f463aebd1f
2 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -12,6 +12,14 @@ You need `less` npm package insalled. you can add it your project by running:
npm install less npm install less
``` ```
## Installation
To install this package simply run:
```bash
npm install lessc-watcher
```
## How to use ## How to use
There are few different ways to run your less compiler There are few different ways to run your less compiler
@ -19,19 +27,19 @@ There are few different ways to run your less compiler
#### Basic usage #### Basic usage
```bash ```bash
less-watcher --src ./folder --dst ./dist/less.css lessc-watcher --src ./folder --dst ./dist/less.css
``` ```
This traverses the folder and searches for a `main.less` file. This file serves as the source for your bundled `.css` file. If you want to target a specific file, use: This traverses the folder and searches for a `main.less` file. This file serves as the source for your bundled `.css` file. If you want to target a specific file, use:
```bash ```bash
less-watcher --src ./folder/src.less --dst ./dist/less.css lessc-watcher --src ./folder/src.less --dst ./dist/less.css
``` ```
Or you can just watch an entire folder. In this case less-watch will searc for an entry file named `main.less`. Without this entry file, your compiler wouldn't work. Or you can just watch an entire folder. In this case less-watch will searc for an entry file named `main.less`. Without this entry file, your compiler wouldn't work.
```bash ```bash
less-watcher --src ./folder --dst ./dist/less.css lessc-watcher --src ./folder --dst ./dist/less.css
``` ```
#### Adding more source folders #### Adding more source folders
@ -39,14 +47,14 @@ less-watcher --src ./folder --dst ./dist/less.css
You can add more source folders by using a comma(`,`) separator. Example: You can add more source folders by using a comma(`,`) separator. Example:
```bash ```bash
less-watcher --src ./folder-1,./folder-2 --dst ./dist/folder-1.css,./dist/folder-2.css lessc-watcher --src ./folder-1,./folder-2 --dst ./dist/folder-1.css,./dist/folder-2.css
``` ```
**_NOTE:_** Your `--dst` input must match the number of comma-separated folders in your `src` input. **_NOTE:_** Your `--dst` input must match the number of comma-separated folders in your `src` input.
#### Advanced Features #### Advanced Features
less-watcher has more advanced features to better fine-tune your files lessc-watcher has more advanced features to better fine-tune your files
##### Ignore files ##### Ignore files

2
package.json
View File

@ -1,6 +1,6 @@
{ {
"name": "lessc-watcher", "name": "lessc-watcher",
"version": "1.0.6", "version": "1.0.7",
"description": "A minimal package to watch less files and compile them to css", "description": "A minimal package to watch less files and compile them to css",
"main": "dist/index.js", "main": "dist/index.js",
"repository": { "repository": {