diff options
Diffstat (limited to 'docs/api/README.md')
| -rw-r--r-- | docs/api/README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/api/README.md b/docs/api/README.md index 4349fd4..c3beb6e 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -1,3 +1,24 @@ # Plugin Architecture A GitBook plugin is a NPM package that follow a defined convention. + +`gitbook-plugin` is a command line utility to help you create, test and release plugins. + +### Bootstrap your first plugin + +Install `gitbook-plugin` from NPM: + +``` +$ npm install gitbook-plugin -g +``` + +Then create your plugin using: + +``` +$ gitbook-plugin create +``` + +It will prompt you to enter a name and a description. + + +### Publish your plugin |