Skip to content

Commit

Permalink
updating Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
guilhermedupont committed Oct 6, 2012
1 parent 635a5e4 commit f1cf591
Show file tree
Hide file tree
Showing 4 changed files with 82 additions and 3 deletions.
1 change: 1 addition & 0 deletions .npmignore
Original file line number Original file line Diff line number Diff line change
@@ -1,3 +1,4 @@
.git
tasks.todo tasks.todo
npm-debug.log npm-debug.log
node_modules node_modules
80 changes: 79 additions & 1 deletion Readme.md
Original file line number Original file line Diff line number Diff line change
@@ -1,6 +1,6 @@
# less-livereload # less-livereload


Monitor and Live Reload LESS files in your browser. Monitor, parse and Live Reload LESS files in your browser.


## Features ## Features


Expand Down Expand Up @@ -66,6 +66,8 @@ To get the option list, type:
less-livereload -h less-livereload -h
``` ```


For more information, see [less-monitor docs](https://github.com/gdupont/less-monitor).

### Browser plugin ### Browser plugin


Now, if you are using Safari, right-click the page you want to be livereload'ed and choose “Enable LiveReload”: Now, if you are using Safari, right-click the page you want to be livereload'ed and choose “Enable LiveReload”:
Expand All @@ -74,3 +76,79 @@ Now, if you are using Safari, right-click the page you want to be livereload'ed


If you are using Chrome or Firefox, just click the toolbar button (it will turn green to indicate that LiveReload is active). If you are using Chrome or Firefox, just click the toolbar button (it will turn green to indicate that LiveReload is active).


### Options

```
--port, -p Sets the server port of LiveReload. Defaults to 35729.
--urlpath, -r Sets the root HTTP directory.
```


```
--directory, -d Define the root directory to watch, if this is not
defined the program will use the current working
directory.
--output, -o Define the directory to output the files, if this is not
defined the program will use the same directory from file.
--match, -m Matching files that will be processed. Defaults to
**/*.less
--extension, -e Sets the extension of the files that will be generated.
Defaults to .css
--force, -f Force to recompile all files on startup before start
watching files.
--ignore, -i Define the ignore file list. Can be a file or directory.
Ex: **/src/_*.less
--interval, -t Sets the interval in miliseconds of the files that will
be watching. Defaults to 250
--nofollow, -n If set will not follow @import dependencies. Defaults to
false.
--optimization, -p Sets the optimization level for the less compiler,
options are: 0, 1, and 2.
--compress, -c Compresses the output
--silent, -s Sets to silent mode. Starts without log output.
--options, -u Show options on startup.
--master, -x Process only master files. Master files are not dependent
from any others. Defaults to false
--help, -h Show this message
```

## License

(The MIT License)

Copyright (c) 2012 Guilherme Dupont <guilhermedupont@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2 changes: 1 addition & 1 deletion lib/livereload.js
Original file line number Original file line Diff line number Diff line change
@@ -1,7 +1,7 @@
/** /**
--- ---
@name Less Monitor - LiveReload plugin @name Less Monitor - LiveReload plugin
@description Monitor and recompile your LESS files with automatic backwards @import parsing. @description Monitor, parse and Live Reload LESS files in your browser.
@author Guilherme Dupont @author Guilherme Dupont
@version 0.1.0 @version 0.1.0
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Original file line Diff line number Diff line change
@@ -1,7 +1,7 @@
{ {
"name": "less-livereload", "name": "less-livereload",
"version": "0.1.0", "version": "0.1.0",
"description": "Monitor and LiveReload LESS files in your browser.", "description": "Monitor, parse and Live Reload LESS files in your browser.",
"author": { "author": {
"name": "Guilherme Dupont", "name": "Guilherme Dupont",
"email": "guilhermedupont@gmail.com" "email": "guilhermedupont@gmail.com"
Expand Down

0 comments on commit f1cf591

Please sign in to comment.