Merge pull request #13 from specialblend/support/peer-deps

refactor: move dependencies to peerDependencies
specialblend · Oct 5, 2021 · ecfcf16 · ecfcf16
2 parents def66ef + 91328bc
commit ecfcf16
Show file tree

Hide file tree

Showing 3 changed files with 122 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,28 @@
 
 map, filter, and transform data structures using GraphQL and JSONPath.
 
+## installation
+
+```bash
+# install peerDependencies
+npm install graphql graphql-anywhere graphql-tag rambda jsonpath
+# install package
+npm install --registry=https://npm.pkg.github.com/specialblend @specialblend/mapql
+```
+
+or add `.npmrc`:
+
+```
+registry=https://registry.npmjs.org/
+@specialblend:registry=https://npm.pkg.github.com/specialblend
+```
+
+and run
+
+```bash
+npm install @specialblend/mapql graphql graphql-anywhere graphql-tag rambda jsonpath
+```
+
 ## features
 
 GraphQL query is written in desired result structure, using GraphQL arguments and directives for remapping paths and transforming result values.