Update README.md

Author: Chen Asraf

README.md

@@ -1,50 +1,70 @@
-# simple-scaffolder
-Scaffolder allows you to create your structured files based on templates.
+# simple-scaffold
+Simple Scaffold allows you to create your structured files based on templates.
 
 ## Install
 You can either use it as a command line tool or import into your own code and run from there.
 
-You can install simple-scaffold globally like so:
-
 ```bash
 # npm
-npm install -g simple-scaffold
+npm install [-g] simple-scaffold
 # yarn
-yarn global add simple-scaffold
+yarn [global] add simple-scaffold
 ```
 
 ## Use as a command line tool
-### Command line options
+The first non-token argument (that has no `--` prefix) will be used as the scaffold name.
+The rest is ignored, of course except for the available arguments below.
 
 ```bash
 simple-scaffold MyComponent --template scaffolds/component/**/* \
     --output src/components \
     --locals myProp="propname",myVal=123
 ```
 
-##### `--template glob [--template glob2 [...]]`
-A glob pattern of template files to load.
+You can add this as a script in your `package.json`:
+
+```json
+{
+  "scripts": {
+    "scaffold": "node node_modules/simple-scaffold/dist/cmd.js --template scaffolds/component/**/* --output src/components --locals myProp=\"propname\",myVal=123"
+  }
+}
+```
+
+## Scaffolding
+Scaffolding will replace {{vars}} in both the file name and its contents and put the transformed files
+in `<output>/<{{Name}}`.
+
+Your context will be pre-populated with the following:
+- `{{Name}}`: CapitalizedName of the component
+- `{{name}}`: camelCasedName of the component
+
+Any `locals` you add in the config will populate with their names wrapped in `{{` and `}}`.
+They are all stringified, so be sure to parse them accordingly by creating a script, if necessary.
 
+### Command line options
+##### `--template glob [--template glob2 [...]]` (required)
+A glob pattern of template files to load.
 
 A template file may be of any type and extension, and supports [Handlebars](https://handlebarsjs.com) as a parsing engine for the file names and contents, so you may customize both with variables from your configuration.
 
-You may load more than one template list by simple adding more `--template` arguments.
+You can load more than one template list by simple adding more `--template` arguments.
 
-##### `--output path`
+##### `--output path` (optional)
 The output directory to put the new files in. They will attempt to maintain their regular structure as they are found, if possible.
 
 Your new scaffold will be placed under a directory with the scaffold name from the argumemts.
 
 You may also pass a function to transform the output path for each file individually.
 This function takes 2 arguments: filename, and base glob path
 
-##### `--locals key=value[,key=value[,...]]`
+##### `--locals key=value[,key=value[,...]]` (optional)
 Pass a KV map to the template for parsing.
 
 ### Use in Node.js
-You can also build the scaffold yourself.
+You can also build the scaffold yourself, if you want to create more complex arguments or scaffold groups.
 Simply pass a config object to the constructor, and invoke `run()` when you are ready to start.
-The config takes the same arguments as the command line:
+The config takes similar arguments to the command line:
 
 ```javascript
 const SimpleScaffold = require('simple-scaffold').default
@@ -60,32 +80,26 @@ const scaffold = new SimpleScaffold({
 ```
 
 ## Example Scaffold Input
-Scaffolding will replace interpolations in both the file name and contents.
-
-Your context will be pre-populated with
-- `{{Name}}`: CapitalizedName of the component
-- `{{name}}`: camelCasedName of the component
-
-Any `locals` you add in the config will populate with their names wrapped in `{{` and `}}`.
 
 ### Input Directory structure
 ```
 - project
     - scaffold
+        - {{Name}}.js
         - {{Name}}.css
     - src
         - components
         - ...
 ```
 
-#### project/scaffold/{{Name}}.css
-```css
-.{{className}} {
-  border: 1px solid black;
-}
+#### project/scaffold/{{Name}}.js
+```js
+const React = require('react')
 
-.{{className}}-child {
-  background: red;
+module.exports = class {{Name}} extends React.Component {
+  render() {
+    <div className="{{className}}">{{Name}} Component</div>
+  }
 }
 ```
 
@@ -108,13 +122,13 @@ simple-scaffold MyComponent \
         - ...
 ```
 
-#### project/src/components/MyComponent/MyComponent.css
-```css
-.my-component {
-  border: 1px solid black;
-}
+#### project/scaffold/MyComponent/MyComponent.js
+```js
+const React = require('react')
 
-.my-component-child {
-  background: red;
+module.exports = class MyComponent extends React.Component {
+  render() {
+    <div className="my-component">MyComponent Component</div>
+  }
 }
 ```