docs: specify web-pkg as dev dependency

owncloud · Oct 11, 2024 · 308b59c · 308b59c
1 parent f57ad6f
commit 308b59c
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/packages/web-pkg/README.md b/packages/web-pkg/README.md
@@ -7,9 +7,11 @@
 Depending on your package manager, run one of the following commands:
 
 ```
-$ npm install @ownclouders/web-pkg
+$ npm install @ownclouders/web-pkg --save-dev
 
-$ pnpm add @ownclouders/web-pkg
+$ pnpm add -D @ownclouders/web-pkg
 
-$ yarn add @ownclouders/web-pkg
+$ yarn add @ownclouders/web-pkg --dev
 ```
+
+It's recommended to install this package as a dev dependency because it's only really needed for providing autocompletion in your IDE and unit tests. In a runtime context, the ownCloud Web runtime provides the actual implementation.