Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Aug 8, 2017
1 parent 27a06f6 commit 7479c7a
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
*~
*.log
node_modules
*.env
11 changes: 11 additions & 0 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@ You can see below the API reference of this module.
Creates a new `Blah` instance.

#### Params

- **String** `cwd`: The Blah working directory (default: `process.cwd()`).

### `search(file, callback)`
Searches a file in the blah directories.

#### Params

- **String** `file`: The relative path to a file to search in the templates directories (in the following order: local `.blah` directory,
`~/.blah-templates`, library templates).
- **Function** `callback`: The callback function.
Expand All @@ -20,18 +22,21 @@ Searches a file in the blah directories.
Prepares the Blah data.

#### Params

- **Function** `callback`: The callback function.

### `init(callback)`
Inits the `.blah` directory in the current project.

#### Params

- **Function** `callback`: The callback function.

### `docs(input, output, writeToFile, callback)`
Generates the DOCUMENTATION.md file, parsing the input files.

#### Params

- **String** `input`: Input file name (default: main file from package.json)
- **String** `output`: Output file name (default: `DOCUMENTATION.md`)
- **Boolean** `writeToFile`: If `false`, the docs will be returned via the callback function, without writing the output file.
Expand All @@ -41,25 +46,29 @@ Generates the DOCUMENTATION.md file, parsing the input files.
Creates the `README.md` file.

#### Params

- **Function** `callback`: The callback function

### `gitignore(callback)`
Creates the `.gitignore` file.

#### Params

- **Function** `callback`: The callback function.

### `license(license, callback)`
Creates the `LICENSE` file.

#### Params

- **String** `license`: The license name.
- **Function** `callback`: The callback function.

### `render(path, data, callback)`
Renders a template from file.

#### Params

- **String** `path`: The template path.
- **Object** `data`: Additional data to merge into the template data.
- **Function** `callback`: The callback function.
Expand All @@ -68,12 +77,14 @@ Renders a template from file.
Generates the `CONTRIBUTING.md` file.

#### Params

- **Function** `callback`: The callback function.

### `version(what, callback)`
Bumps the provided version.

#### Params

- **String** `what`: The version which should be bumped. It takes one of the following values: `"major"`, `"minor"`, `"patch"`. The default is `"patch"`.
- **Function** `callback`: The callback function.

0 comments on commit 7479c7a

Please sign in to comment.