summaryrefslogtreecommitdiffstats
path: root/packages/gitbook-plugin/CONTRIBUTING.md
diff options
context:
space:
mode:
authorSamy Pessé <samypesse@gmail.com>2016-12-22 10:18:38 +0100
committerGitHub <noreply@github.com>2016-12-22 10:18:38 +0100
commit194ebc3da9641ff96f083f9d8ab43c2d27944f9a (patch)
treec50988f32ccf18df93ae7ab40be78e9459642818 /packages/gitbook-plugin/CONTRIBUTING.md
parent64ccb6b00b4b63fa0e516d4e35351275b34f8c07 (diff)
parent16af264360e48e8a833e9efa9ab8d194574dbc70 (diff)
downloadgitbook-194ebc3da9641ff96f083f9d8ab43c2d27944f9a.zip
gitbook-194ebc3da9641ff96f083f9d8ab43c2d27944f9a.tar.gz
gitbook-194ebc3da9641ff96f083f9d8ab43c2d27944f9a.tar.bz2
Merge pull request #1543 from GitbookIO/dream
React for rendering website with plugins
Diffstat (limited to 'packages/gitbook-plugin/CONTRIBUTING.md')
-rw-r--r--packages/gitbook-plugin/CONTRIBUTING.md11
1 files changed, 11 insertions, 0 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
+```