Browse Source

Also cover the case when installing companion without a JS project /thx @canvasbh

Kevin van Zonneveld 6 years ago
parent
commit
116865284e
2 changed files with 5 additions and 1 deletions
  1. 2 0
      packages/@uppy/companion/README.md
  2. 3 1
      website/src/docs/companion.md

+ 2 - 0
packages/@uppy/companion/README.md

@@ -15,6 +15,8 @@ Instagram, etc. **Companion is not a target to upload files to**. For this, use
 npm install @uppy/companion
 ```
 
+If you don't have a Node.js project with a `package.json` you might want to install/run Companion globally like so: `[sudo] npm install -g @uppy/companion@0.30.0`.
+
 ## Usage
 
 companion may either be used as pluggable express app, which you plug to your already existing server, or it may simply be run as a standalone server:

+ 3 - 1
website/src/docs/companion.md

@@ -30,9 +30,11 @@ As of now, Companion is integrated to work with:
 Install from NPM:
 
 ```bash
-sudo npm install -g @uppy/companion
+npm install @uppy/companion
 ```
 
+If you don't have a Node.js project with a `package.json` you might want to install/run Companion globally like so: `[sudo] npm install -g @uppy/companion@0.30.0`.
+
 ## Usage
 
 Companion may either be used as a pluggable express app, which you plug into your already existing server, or it may simply be run as a standalone server: