aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcel <cel@lOUVT+Phkvai9a/cCS/RKo+S9hnPAQdVixms/7ldpPA=.ed25519>2020-07-09 19:45:22 -0400
committercel <cel@lOUVT+Phkvai9a/cCS/RKo+S9hnPAQdVixms/7ldpPA=.ed25519>2020-07-09 19:47:16 -0400
commit45c42b23f73184841b517981e1cb182ee53e4f0d (patch)
tree0d8bac1df1f7b052953d0f16d2f9b3c65eaee382
parentf0770031cf26aff95431ddeb5b173c1e0be36c12 (diff)
downloadpatchfoo-45c42b23f73184841b517981e1cb182ee53e4f0d.tar.gz
patchfoo-45c42b23f73184841b517981e1cb182ee53e4f0d.zip
Add message id for ssb-client for standalone install
ssb-npm does not include cypherlinks for devDependencies. Since ssb-client is a devDependency, we then have to add an additional --branch parameter for it.
-rw-r--r--README.md10
-rw-r--r--doc/install-guide.html9
2 files changed, 13 insertions, 6 deletions
diff --git a/README.md b/README.md
index 6769a85..33c9c55 100644
--- a/README.md
+++ b/README.md
@@ -82,7 +82,9 @@ Running as a standalone process this way is useful if you can use git-ssb and ss
```sh
git clone ssb://%YAg1hicat+2GELjE2QJzDwlAWcx0ML+1sXEdsWwvdt8=.sha256 patchfoo
cd patchfoo
-ssb-npm install --branch %e/unnFWjNwhJuFtH+DmkNqqvVggrufu/sZxRU5e59Is=.sha256
+ssb-npm install \
+ --branch %e/unnFWjNwhJuFtH+DmkNqqvVggrufu/sZxRU5e59Is=.sha256 \
+ --branch %FlwIBeDR/liKcEvok7uF9o3e7Qib36aMj1orj3aiFVQ=.sha256
npm start
```
@@ -90,7 +92,7 @@ npm start
This is the traditional way to install and run patchfoo.
-Using `--production` skips installing `ssb-client`, which is not needed for plugin usage. If you want to also be able to run patchfoo as a standalone process, omit the `--production` option in the commands below.
+Using `--production` skips installing `ssb-client`, which is not needed for plugin usage. If you want to also be able to run patchfoo as a standalone process, omit the `--production` option in the commands below, and add the extra `--branch` parameter as used above.
```sh
cd ~/.ssb/node_modules
@@ -120,7 +122,9 @@ This installs patchfoo globally and gives you a `patchfoo` executable.
Note: if you previously installed a patchfoo binary release, [ssb-]npm will not overwrite it. You must manually remove it (e.g. `rm ~/.local/bin/patchfoo`) before installing via ssb-npm.
```sh
-ssb-npm install -g patchfoo --branch %e/unnFWjNwhJuFtH+DmkNqqvVggrufu/sZxRU5e59Is=.sha256
+ssb-npm install -g patchfoo \
+ --branch %e/unnFWjNwhJuFtH+DmkNqqvVggrufu/sZxRU5e59Is=.sha256 \
+ --branch %FlwIBeDR/liKcEvok7uF9o3e7Qib36aMj1orj3aiFVQ=.sha256
```
### as a ssb-server plugin
diff --git a/doc/install-guide.html b/doc/install-guide.html
index a5dea45..04a07cf 100644
--- a/doc/install-guide.html
+++ b/doc/install-guide.html
@@ -42,7 +42,9 @@ ssb-npm install -g git-ssb@2.8.0 \
<pre>
git clone ssb://%YAg1hicat+2GELjE2QJzDwlAWcx0ML+1sXEdsWwvdt8=.sha256 patchfoo
cd patchfoo
-ssb-npm install --branch %e/unnFWjNwhJuFtH+DmkNqqvVggrufu/sZxRU5e59Is=.sha256
+ssb-npm install \
+ --branch %e/unnFWjNwhJuFtH+DmkNqqvVggrufu/sZxRU5e59Is=.sha256 \
+ --branch %FlwIBeDR/liKcEvok7uF9o3e7Qib36aMj1orj3aiFVQ=.sha256
npm start
</pre>
@@ -52,8 +54,9 @@ mkdir ~/.ssb/node_modules
cd ~/.ssb/node_modules
git clone ssb://%YAg1hicat+2GELjE2QJzDwlAWcx0ML+1sXEdsWwvdt8=.sha256 patchfoo
cd patchfoo
-ssb-npm install --branch %e/unnFWjNwhJuFtH+DmkNqqvVggrufu/sZxRU5e59Is=.sha256
-sbot plugins.enable patchfoo
+ssb-npm install --production \
+ --branch %e/unnFWjNwhJuFtH+DmkNqqvVggrufu/sZxRU5e59Is=.sha256
+node enable-plugin.js
</pre>
<p>Restart ssb-server or Patchwork.</p>
<p>Visit patchfoo at <a href="http://localhost:8027/">http://localhost:8027/</a>.</p>