summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSoreine <nicolas@gitbook.com>2016-12-02 17:34:54 +0100
committerSoreine <nicolas@gitbook.com>2016-12-02 17:34:54 +0100
commite1bcb4ed7d7737bb3a8e36a511f016cac1893ec6 (patch)
treed477af3ed05f91cc50731b57cc02baf5282a6fdd
parent4aae18617bf52279e78e4d2193f7f6c7c4e722a4 (diff)
downloadgitbook-e1bcb4ed7d7737bb3a8e36a511f016cac1893ec6.zip
gitbook-e1bcb4ed7d7737bb3a8e36a511f016cac1893ec6.tar.gz
gitbook-e1bcb4ed7d7737bb3a8e36a511f016cac1893ec6.tar.bz2
plugin: Add CONTRIBUTING.md
-rw-r--r--packages/gitbook-plugin/CONTRIBUTING.md11
-rw-r--r--packages/gitbook-plugin/README.md2
2 files changed, 12 insertions, 1 deletions
diff --git a/packages/gitbook-plugin/CONTRIBUTING.md b/packages/gitbook-plugin/CONTRIBUTING.md
new file mode 100644
index 0000000..19119b6
--- /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 64f2ce9..b2dab88 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/).