From e1bcb4ed7d7737bb3a8e36a511f016cac1893ec6 Mon Sep 17 00:00:00 2001 From: Soreine Date: Fri, 2 Dec 2016 17:34:54 +0100 Subject: [PATCH] plugin: Add CONTRIBUTING.md --- packages/gitbook-plugin/CONTRIBUTING.md | 11 +++++++++++ packages/gitbook-plugin/README.md | 2 +- 2 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 packages/gitbook-plugin/CONTRIBUTING.md diff --git a/packages/gitbook-plugin/CONTRIBUTING.md b/packages/gitbook-plugin/CONTRIBUTING.md new file mode 100644 index 000000000..19119b6b2 --- /dev/null +++ b/packages/gitbook-plugin/CONTRIBUTING.md @@ -0,0 +1,11 @@ +Compile the CLI using: + +``` +npm run dist +``` + +Then run the CLI in `lib/`: + +``` +./lib/cli.js +``` diff --git a/packages/gitbook-plugin/README.md b/packages/gitbook-plugin/README.md index 64f2ce9c5..b2dab8809 100644 --- a/packages/gitbook-plugin/README.md +++ b/packages/gitbook-plugin/README.md @@ -1 +1 @@ -See [GitBook: Create a plugin](toolchain.gitbook.com/api/). +For instructions on how to create plugins, see [GitBook: Create a plugin](toolchain.gitbook.com/api/).