chore: readme (#165)

patrickmichalina · web-flow · commit a8c837528ecf · 2021-04-25T12:35:17.000-05:00
diff --git a/README.md b/README.md
@@ -34,8 +34,8 @@ npm install typescript-monads
 ```html
 <head>
  <script src="https://unpkg.com/typescript-monads"></script>
- <!-- or use a specific version to avoid a redirect --> 
- <script src="https://unpkg.com/typescript-monads@4.1.0/index.min.js"></script>
+ <!-- or use a specific version to avoid a http redirect --> 
+ <script src="https://unpkg.com/typescript-monads@5.3.0/index.min.js"></script>
 </head>
 ```
 
@@ -51,37 +51,11 @@ typescriptMonads.maybe(someRemoteValue).tapSome(console.log)
 * [Either](#either)
 * [Reader](#reader)
 * [Result](#result)
+* [State](#state)
+* [Logger](#logger)
 
 # Maybe
-```ts
-import { maybe } from 'typescript-monads'
-
-// safely map values
-let maybeVisitedBeforeXTimes: number | undefined = 50
-
-const priceWithDiscountForLoyalty = maybe(maybeVisitedBeforeXTimes)
-  .match({
-    some: visits => 15.00 - visits * 0.1,
-    none: () => 15.00
-  })
-
-// handle multiple maybe conditions together
-const canRideCoaster = getAge() // Maybe<number>
-  .map(age => getTicket(age)) // Maybe<Ticket>
-  .match({
-    some: ticket => ticket.canRide('coaster1'),
-    none: () => false
-  })
-
-// operations with side-effects
-maybe(process.env.DB_URL)
-  .tap({
-    some: dbUrl => {
-      // value exists, can connect
-    },
-    none: () => console.info('no url provided, could not connect to the database')
-  })
-```
+TODO
 
 ## List
 TODO
@@ -94,3 +68,9 @@ TODO
 
 ## Result
 TODO
+
+## State
+TODO
+
+## Logger
+TODO
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -24,11 +24,13 @@
     "result",
     "either",
     "list",
+    "state",
     "functional",
     "list-monad",
     "maybe-monad",
     "either-monad",
-    "result-monad"
+    "result-monad",
+    "state-monad"
   ],
   "scripts": {
     "test": "jest",
@@ -52,7 +54,7 @@
     "codecov": "^3.8.1",
     "eslint": "^7.25.0",
     "eslint-plugin-promise": "^5.1.0",
-    "eslint-plugin-rxjs": "3.1.5",
+    "eslint-plugin-rxjs": "3.2.0",
     "fast-check": "^2.14.0",
     "fs-extra": "^9.1.0",
     "istanbul": "^0.4.5",
