maraj 1.0.1 → 1.0.3

package/README.md

@@ -1,9 +1,9 @@
 
-# Immutable Maraj
+# Maraj
 
-A lightweight alternative for creating immutable updates of objects and arrays.
-4 times faster than the commonly used alternatives like Immer or ImmutableJS.
-Only 600 bytes gziped with 5 common utilities that you will most likelly need in every project.
+A lightweight alternative for creating **immutable updates of objects and arrays.**
+**4 times faster** than the commonly used alternatives like Immer or ImmutableJS.
+Only **600 bytes** gziped with 5 common utilities that you will most likelly need in every project.
 Features:
 - Can accept multiple updates while mantaining the order of execution.
 - Easy syntax for conditional updates.
@@ -11,23 +11,24 @@ Features:
 
 ## Creating an Immutable Update
 
-The createImmutableUpdate function has two arguments:
-- First one: The original object we want to update non-destructively
-- Second one: An update object with key-value pairs representing the updates we want to make
+The **createImmutableUpdate** function has two arguments:
+1. The **original object** we want to update non-destructively
+2. An **update object** with key-value pairs representing the updates we want to make
 
-The updateObject has the following syntax:
+The **updateObject** has the following syntax:
 
 - It can accept multiple key-value pairs and the order of execution will be preserved.
 
-- Key: path name of the fiels, separated by commas (same syntax you use to access object properties)
+- **Key:** path name of the fiels, separated by commas (same syntax you use to access object properties)
 (for arrays just use its index value)
 (can accept conditional statements. If the key is falsy, undefined or null it will not update the new value into the new object.)
 
-- Value: can be any type, including a function, where its argument will be the current value and its return value has to be the new value to be updated
+- **Value:** can be any type, including a function, where its argument will be the current value and its return value has to be the new value to be updated
 
 
 ## Example
 
+```js
 import createImmutableUpdate from 'maraj'
 
 const person = {
@@ -74,51 +75,55 @@ const person = {
 }
 
 createImmutableUpdate(person,{
-    'name': Maraj       //normal update
-    'projects.0.title': 'personal website'      //nested update
-    'projects.1.available': true     //nested update
-    'projects.1.available': (currentValue) => !currentValue     //functional update
-    'projects': (currentValue) => currentValue.filter(project => project.available)     //functional update
-    [condition && 'additionalInfo.info1']: 'some info'      //conditional update, only if the key is not false/undefined/null
+    'name': Maraj //normal update
+    'projects.0.title': 'personal website' //nested update
+    'projects.1.available': true //nested update
+    'projects.1.available': (currentValue) => !currentValue //functional update
+    'projects': (currentValue) => currentValue.filter(project => project.available) //functional update
+    [condition && 'additionalInfo.info1']: 'some info' //conditional update, only if the key is not false/undefined/null
 })
-
+```
 
 ## Other Utilities
 
 ### spread
 
-Spreads its argument into the key provided in the createImmutableUpdate.
+Spreads its argument into the key provided in the **createImmutableUpdate.**
 Works with objects(updates its keys) and arrays(adds new values to the array)
 
-
+```js
 import {spread} from 'maraj'
 
 createImmutableUpdate(person,{
-    'additionalInfo.info1': spread({info1: 'new Info'})     //same as (newValue) => (value) => ({...value, ...newValue})
-    'projects': spread({title: 'new project'})      //same as (newValueToAdd) => (value) => ([...value, ...newValueToAdd])
+    'additionalInfo.info1': spread({info1: 'new Info'}) //same as (newValue) => (value) => ({...value, ...newValue})
+    'projects': spread({title: 'new project'}) //same as (newValueToAdd) => (value) => ([...value, ...newValueToAdd])
 })
-
+```
 
 ### remove
 
-Removes the key of an object or the index of an array in the key provided in the createImmutableUpdate.
+Removes the key of an object or the index of an array in the key provided in the **createImmutableUpdate.**
 
-import {spread} from 'maraj'
+```js
+import {remove} from 'maraj'
 
 createImmutableUpdate(person,{
-    'additionalInfo': remove('info1')     // returns new value (in this case "additionalInfo") without the provided key ("info1")
-    'projects': remove(1)      // returns new array (in this case "projects") without the provided index (1)
+    'additionalInfo': remove('info1') // returns new value (in this case "additionalInfo") without the provided key ("info1")
+    'projects': remove(1) // returns new array (in this case "projects") without the provided index (1)
 })
-
+```
 
 ### createSelectorFromStringPath
 
 Creates a store selector from provided string path. Usefull in cases like getting data from Redux, Zustand, and so on. stores.
 
+```js
+import {createSelectorFromStringPath} from 'maraj'
+
 const stringPath = 'projects.1.data.size'
 
 createSelectorFromStringPath(stringPath) // will behave as (store) => store[projects][1][data][size]
-
+```
 
 ### splitPath
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "maraj",
-  "version": "1.0.1",
-  "description": "A lightweight 500 bytes alternative for immutable updates while dealing with objects and arrays",
+  "version": "1.0.3",
+  "description": "A lightweight 600 bytes gzipped alternative for immutable updates while dealing with objects and arrays",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"