stealjs / steal-less

A less plugin for StealJS
https://www.npmjs.com/package/steal-less
MIT License
4 stars 2 forks source link

Conflated "Install" and "Use" steps in README #49

Closed leoj3n closed 7 years ago

leoj3n commented 7 years ago

The current "Use" step in the README should really be part of the "Install" step:

Install

Install steal-less as an npm dependency:

npm install steal-less --save-dev

Next, add steal-less as a plugin to the steal section of package.json:

...

"steal": {
  "plugins": [
    "steal-less"
  ]
}
...
"steal": {
  "plugins": [
    "steal-less"
  ]
}

Then, the "Use" step should probably be updated to something like:

Use

Once installed, steal-less allows you to import/require/steal Less files within your project:

// ES6
import "style.less!";

// AMD
define(["style.less!"],function(){ ... });

// CommonJS
require("style.less!");

// steal
steal("style.less!")

I can submit a PR for this if it's agreeable.

matthewp commented 7 years ago

Sure

leoj3n commented 7 years ago

Closed by #51