Skip to content

Commit

Permalink
Fixing the readme for the 2.0.0 release.
Browse files Browse the repository at this point in the history
  • Loading branch information
Zoramite committed Feb 22, 2015
1 parent 5902c1a commit 9beac0a
Showing 1 changed file with 7 additions and 53 deletions.
60 changes: 7 additions & 53 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
**The less-middleware has recently been updated to version `1.0.4`.**

**If you are seeing an error similar to `TypeError: Arguments to path.join must be strings` please read the [migration guide](https://github.com/emberfeather/less.js-middleware/wiki/Migration-0.1.x-1.0.x) to update your code.**

This middleware was created to allow processing of [Less](http://lesscss.org) files for [Connect JS](http://www.senchalabs.org/connect/) framework and by extension the [Express JS](http://expressjs.com/) framework.

[![Build Status](https://drone.io/github.com/emberfeather/less.js-middleware/status.png)](https://drone.io/github.com/emberfeather/less.js-middleware/latest)
Expand Down Expand Up @@ -41,11 +37,6 @@ The following options can be used to control the behavior of the middleware:
</tr>
</thead>
<tbody>
<tr>
<th><code>compiler</code></th>
<td>Options for the less compiler. See the "<code>compiler</code> Options" section below.</td>
<td>&hellip;</td>
</tr>
<tr>
<th><code>debug</code></th>
<td>Show more verbose logging?</td>
Expand All @@ -66,11 +57,6 @@ The following options can be used to control the behavior of the middleware:
<td>Only recompile once after each server restart. Useful for reducing disk i/o on production.</td>
<td><code>false</code></td>
</tr>
<tr>
<th><code>parser</code></th>
<td>Options for the less parser. See the "<code>parser</code> Options" section below.</td>
<td>&hellip;</td>
</tr>
<tr>
<th><code>pathRoot</code></th>
<td>Common root of the source and destination. It is prepended to both the source and destination before being used.</td>
Expand Down Expand Up @@ -101,6 +87,11 @@ The following options can be used to control the behavior of the middleware:
<td>Function that modifies the less pathname before being loaded from the filesystem.</td>
<td><code>function(pathname, req){...}</code></td>
</tr>
<tr>
<th><code>render</code></th>
<td>Options for the less render. See the "<code>render</code> Options" section below.</td>
<td>&hellip;</td>
</tr>
<tr>
<th><code>storeCss</code></th>
<td>Function that is in charge of storing the css in the filesystem.</td>
Expand All @@ -114,9 +105,9 @@ The following options can be used to control the behavior of the middleware:
</tbody>
</table>

## `compiler` Options
## `render` Options

The `options.compiler` is passed directly into the less parser with minimal defaults or changes by the middleware.
The `options.render` is passed directly into the `less.render` with minimal defaults or changes by the middleware.

The following are the defaults used by the middleware:

Expand All @@ -132,50 +123,13 @@ The following are the defaults used by the middleware:
<th><code>compress</code></th>
<td><code>auto</code></td>
</tr>
<tr>
<th><code>sourceMap</code></th>
<td><code>false</code></td>
</tr>
<tr>
<th><code>yuicompress</code></th>
<td><code>false</code></td>
</tr>
</tbody>
</table>

## `parser` Options

The `options.parser` is passed directly into the less parser with minimal defaults or changes by the middleware.

The following are the defaults used by the middleware:

<table>
<thead>
<tr>
<th>Option</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<th><code>dumpLineNumbers</code></th>
<td><code>0</code></td>
</tr>
<tr>
<th><code>paths</code></th>
<td><code>[source]</code></td>
</tr>
<tr>
<th><code>optimization</code></th>
<td><code>0</code></td>
</tr>
<tr>
<th><code>relativeUrls</code></th>
<td><code>false</code></td>
</tr>
</tbody>
</table>

## Examples

Common examples of using the Less middleware are available in the [wiki](https://github.com/emberfeather/less.js-middleware/wiki/Examples).
Expand Down

0 comments on commit 9beac0a

Please sign in to comment.