Skip to content

Commit

Permalink
Merge pull request #1 from saucal/add/basic-documentation
Browse files Browse the repository at this point in the history
Very minimal documentation.
  • Loading branch information
msaggiorato authored Mar 16, 2022
2 parents db3d54a + 233e76a commit 519af56
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,22 @@
This is meant to be a command to scaffold plugins, themes, projects with the command line.

_This package is inspired by [@wordpress/scripts](https://www.npmjs.com/package/@wordpress/scripts)._

## Installation

To install as a global NPM package:
`npm install -g saucal/scaffold`

## Usage

`sc-scaffold plugin --name="My Plugin Name"`

## Available arguments

- `--branch` (Default: 'master')
- `--name` (Default: '')
- `--slug` (Default: '')
- `--uri` (Default: '')
- `--package` (Default: '')
- `--short` (Default: '')
- `--singleton` (Default: '')

0 comments on commit 519af56

Please sign in to comment.