📝 Update runkit examples and other info (#225)

* 📝 Update runkit examples and other info * 💚 fix immutadot-lodash package file
zenika-open-source · Jan 19, 2018 · abd4e66 · abd4e66
1 parent 514574e
commit abd4e66
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 7 deletions.
diff --git a/packages/immutadot-lodash/.npmignore b/packages/immutadot-lodash/.npmignore
@@ -1,3 +1,2 @@
 /coverage/
-/dist/
 /src/
diff --git a/packages/immutadot-lodash/package.json b/packages/immutadot-lodash/package.json
@@ -1,8 +1,27 @@
 {
   "name": "immutadot-lodash",
   "version": "1.0.0-rc.7",
+  "description": "immutadot-lodash is an extension to immutadot, adding functions based on lodash.",
+  "keywords": [
+    "immutable",
+    "dot-notation",
+    "nested-structures",
+    "react",
+    "redux",
+    "lodash"
+  ],
   "main": "index.js",
   "license": "MIT",
+  "homepage": "https://github.com/Zenika/immutadot/packages/immutadot-lodash",
+  "bugs": "https://github.com/Zenika/immutadot/issues",
+  "repository": "github:Zenika/immutadot",
+  "author": "Nicolas Lepage (https://github.com/nlepage)",
+  "contributors": [
+    "Yvonnick FRIN (https://github.com/frinyvonnick)",
+    "Valentin COCAUD (https://github.com/EmrysMyrddin)",
+    "Charles-Henri GUÉRIN (https://github.com/charlyx)"
+  ],
+  "main": "index.js",
   "peerDependencies": {
     "immutadot": "^1.0.0-rc.7",
     "lodash": "^4.6.0"
@@ -24,5 +43,6 @@
     "test:coverage": "jest -c ../../config/jest.js --maxWorkers=2 --coverage",
     "docs": "jsdoc -c ../../config/jsdoc.json",
     "docs:private": "jsdoc -c ../../config/jsdoc.json -p"
-  }
+  },
+  "runkitExample": "require('immutadot')\nrequire('lodash')\nconst { mapValues } = require('immutadot-lodash')\n\nmapValues({ nested: { map: { a: 1, b: 2, c: 3 } } }, 'nested.map', v => v * v)\n// => { nested: { map: { a: 1, b: 4, c: 9 } } }\n\norderBy({ nested: { people: [{ name: 'Nico', age: 30 }, { name: 'Yvo', age: 2 }, { name: 'Nico', age: 666 }] } }, 'nested.prop', ['name', 'age'], ['desc', 'desc'])\n// => { nested: { people: [{ name: 'Yvo', age: 2 }, { name: 'Nico', age: 666 }, { name: 'Nico', age: 30 }] } }\n"
 }
diff --git a/packages/immutadot/.npmignore b/packages/immutadot/.npmignore
@@ -1,3 +1,2 @@
 /coverage/
-/dist/
 /src/
diff --git a/packages/immutadot/package.json b/packages/immutadot/package.json
@@ -7,8 +7,7 @@
     "dot-notation",
     "nested-structures",
     "react",
-    "redux",
-    "lodash"
+    "redux"
   ],
   "license": "MIT",
   "homepage": "https://github.com/Zenika/immutadot",
@@ -17,7 +16,6 @@
   "author": "Nicolas Lepage (https://github.com/nlepage)",
   "contributors": [
     "Yvonnick FRIN (https://github.com/frinyvonnick)",
-    "Valentin COCAUD (https://github.com/EmrysMyrddin)",
     "Hugo WOOD (https://github.com/hgwood)",
     "Charles-Henri GUÉRIN (https://github.com/charlyx)"
   ],
@@ -40,5 +38,5 @@
     "docs": "jsdoc -c ../../config/jsdoc.json",
     "docs:private": "jsdoc -c ../../config/jsdoc.json -p"
   },
-  "runkitExample": "require('lodash')\nconst immutadot = require('immutadot')\n\nimmutadot.push({ nested: { prop: [1, 2] } }, 'nested.prop', 3, 4)\n// → { nested: { prop: [1, 2, 3, 4] } }\n\nimmutadot.pickBy({ nested: [{ a: 1, b: 2, c: 3, d: 4 }, { e: 6 }] }, 'nested.0', v => v < 3)\n// → { nested: [{ a: 1, b: 2 }, { e: 6 }] }"
+  "runkitExample": "const { set, push } = require('immutadot')\n\nset({ english: { greeting: 'Hi' } }, 'english.greeting', 'Hello')\n// → { english: { greeting: 'Hello' } }\n\npush({ i18n: { languages: ['English', 'French'] } }, 'i18n.languages', 'German', 'Spanish')\n// → { i18n: { languages: ['English', 'French', 'German', 'Spanish'] } }\n"
 }