fix(docs): correct badge links

README.md

@@ -1,13 +1,12 @@
 # redis-x-stream
 
-An [async iterable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/asyncIterator) that emits redis stream entries.
-Requires Redis 5 or greater.
+Create async iterables that emit redis stream entries. Requires Redis 5 or greater.
 
-![release](https://badgen.net/github/release/calebboyd/redis-x-stream)
-![license](https://badgen.net/badge/license/MIT/blue)
+[![release](https://badgen.net/github/release/calebboyd/redis-x-stream)](https://www.npmjs.com/package/redis-x-stream)
+[![license](https://badgen.net/badge/license/MIT/blue)](https://github.com/calebboyd/redis-x-stream/blob/main/LICENSE)
+
+[![test](https://github.com/calebboyd/redis-x-stream/actions/workflows/test.yml/badge.svg)](https://github.com/calebboyd/redis-x-stream/actions)
 
-![test](https://github.com/calebboyd/redis-x-stream/actions/workflows/test.yml/badge.svg
-)
 ## Getting Started
 
 ```javascript

docs/README.md

@@ -2,14 +2,13 @@ redis-x-stream / [Exports](modules.md)
 
 # redis-x-stream
 
-An [async iterable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/asyncIterator) that emits redis stream entries.
-Requires Redis 5 or greater.
+Create async iterables that emit redis stream entries. Requires Redis 5 or greater.
 
-![release](https://badgen.net/github/release/calebboyd/redis-x-stream)
-![license](https://badgen.net/badge/license/MIT/blue)
+[![release](https://badgen.net/github/release/calebboyd/redis-x-stream)](https://www.npmjs.com/package/redis-x-stream)
+[![license](https://badgen.net/badge/license/MIT/blue)](https://github.com/calebboyd/redis-x-stream/blob/main/LICENSE)
+
+[![test](https://github.com/calebboyd/redis-x-stream/actions/workflows/test.yml/badge.svg)](https://github.com/calebboyd/redis-x-stream/actions)
 
-![test](https://github.com/calebboyd/redis-x-stream/actions/workflows/test.yml/badge.svg
-)
 ## Getting Started
 
 ```javascript

docs/classes/RedisStream.md

@@ -52,7 +52,7 @@
 
 #### Defined in
 
-[stream.ts:82](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L82)
+[stream.ts:82](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L82)
 
 ## Properties
 
@@ -62,7 +62,7 @@
 
 #### Defined in
 
-[stream.ts:44](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L44)
+[stream.ts:44](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L44)
 
 ___
 
@@ -72,7 +72,7 @@ ___
 
 #### Defined in
 
-[stream.ts:40](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L40)
+[stream.ts:40](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L40)
 
 ___
 
@@ -82,7 +82,7 @@ ___
 
 #### Defined in
 
-[stream.ts:34](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L34)
+[stream.ts:34](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L34)
 
 ___
 
@@ -92,7 +92,7 @@ ___
 
 #### Defined in
 
-[stream.ts:41](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L41)
+[stream.ts:41](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L41)
 
 ___
 
@@ -102,7 +102,7 @@ ___
 
 #### Defined in
 
-[stream.ts:30](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L30)
+[stream.ts:30](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L30)
 
 ___
 
@@ -112,7 +112,7 @@ ___
 
 #### Defined in
 
-[stream.ts:33](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L33)
+[stream.ts:33](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L33)
 
 ___
 
@@ -122,7 +122,7 @@ ___
 
 #### Defined in
 
-[stream.ts:31](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L31)
+[stream.ts:31](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L31)
 
 ___
 
@@ -132,7 +132,7 @@ ___
 
 #### Defined in
 
-[stream.ts:38](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L38)
+[stream.ts:38](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L38)
 
 ___
 
@@ -142,7 +142,7 @@ ___
 
 #### Defined in
 
-[stream.ts:45](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L45)
+[stream.ts:45](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L45)
 
 ___
 
@@ -154,7 +154,7 @@ Flag for iterable state
 
 #### Defined in
 
-[stream.ts:57](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L57)
+[stream.ts:57](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L57)
 
 ___
 
@@ -164,7 +164,7 @@ ___
 
 #### Defined in
 
-[stream.ts:59](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L59)
+[stream.ts:59](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L59)
 
 ___
 
@@ -174,7 +174,7 @@ ___
 
 #### Defined in
 
-[stream.ts:58](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L58)
+[stream.ts:58](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L58)
 
 ___
 
@@ -184,7 +184,7 @@ ___
 
 #### Defined in
 
-[stream.ts:32](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L32)
+[stream.ts:32](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L32)
 
 ___
 
@@ -194,7 +194,7 @@ ___
 
 #### Defined in
 
-[stream.ts:39](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L39)
+[stream.ts:39](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L39)
 
 ___
 
@@ -208,7 +208,7 @@ Acks waiting to be sent on either:
 
 #### Defined in
 
-[stream.ts:53](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L53)
+[stream.ts:53](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L53)
 
 ___
 
@@ -218,7 +218,7 @@ ___
 
 #### Defined in
 
-[stream.ts:37](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L37)
+[stream.ts:37](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L37)
 
 ## Methods
 
@@ -232,7 +232,7 @@ ___
 
 #### Defined in
 
-[stream.ts:160](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L160)
+[stream.ts:160](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L160)
 
 ___
 
@@ -253,7 +253,7 @@ ___
 
 #### Defined in
 
-[stream.ts:226](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L226)
+[stream.ts:226](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L226)
 
 ___
 
@@ -273,7 +273,7 @@ ___
 
 #### Defined in
 
-[stream.ts:250](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L250)
+[stream.ts:250](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L250)
 
 ___
 
@@ -289,7 +289,7 @@ Iterate through remaining items in the PEL and exit
 
 #### Defined in
 
-[stream.ts:258](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L258)
+[stream.ts:258](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L258)
 
 ___
 
@@ -305,7 +305,7 @@ Immediately stop processing entries
 
 #### Defined in
 
-[stream.ts:266](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L266)
+[stream.ts:266](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L266)
 
 ___
 
@@ -319,7 +319,7 @@ ___
 
 #### Defined in
 
-[stream.ts:212](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L212)
+[stream.ts:212](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L212)
 
 ___
 
@@ -333,4 +333,4 @@ ___
 
 #### Defined in
 
-[stream.ts:277](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L277)
+[stream.ts:277](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L277)

docs/interfaces/RedisStreamOptions.md

@@ -34,7 +34,7 @@ false
 
 #### Defined in
 
-[types.ts:76](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/types.ts#L76)
+[types.ts:76](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/types.ts#L76)
 
 ___
 
@@ -47,7 +47,7 @@ while waiting for new entries on any stream, passed to xread or xreadgroup
 
 #### Defined in
 
-[types.ts:70](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/types.ts#L70)
+[types.ts:70](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/types.ts#L70)
 
 ___
 
@@ -60,7 +60,7 @@ This applies to entry id and kv results
 
 #### Defined in
 
-[types.ts:59](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/types.ts#L59)
+[types.ts:59](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/types.ts#L59)
 
 ___
 
@@ -73,7 +73,7 @@ Note: if only consumer is provided, a group is created automatically
 
 #### Defined in
 
-[types.ts:43](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/types.ts#L43)
+[types.ts:43](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/types.ts#L43)
 
 ___
 
@@ -90,7 +90,7 @@ eg. the "highWaterMark"
 
 #### Defined in
 
-[types.ts:65](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/types.ts#L65)
+[types.ts:65](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/types.ts#L65)
 
 ___
 
@@ -107,7 +107,7 @@ false
 
 #### Defined in
 
-[types.ts:82](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/types.ts#L82)
+[types.ts:82](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/types.ts#L82)
 
 ___
 
@@ -122,7 +122,7 @@ TODO: not yet implemented
 
 #### Defined in
 
-[types.ts:94](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/types.ts#L94)
+[types.ts:94](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/types.ts#L94)
 
 ___
 
@@ -135,7 +135,7 @@ Note: if only a group is provided a consumer is created automatically
 
 #### Defined in
 
-[types.ts:38](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/types.ts#L38)
+[types.ts:38](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/types.ts#L38)
 
 ___
 
@@ -151,7 +151,7 @@ false
 
 #### Defined in
 
-[types.ts:87](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/types.ts#L87)
+[types.ts:87](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/types.ts#L87)
 
 ___
 
@@ -164,7 +164,7 @@ NOTE: by default this connection becomes a "reader" when block > 0
 
 #### Defined in
 
-[types.ts:48](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/types.ts#L48)
+[types.ts:48](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/types.ts#L48)
 
 ___
 
@@ -178,7 +178,7 @@ Only allowed if block = 0 or Infinity
 
 #### Defined in
 
-[types.ts:54](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/types.ts#L54)
+[types.ts:54](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/types.ts#L54)
 
 ___
 
@@ -190,4 +190,4 @@ Redis stream keys to be read. If a Record is provided each value is the starting
 
 #### Defined in
 
-[types.ts:33](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/types.ts#L33)
+[types.ts:33](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/types.ts#L33)

docs/modules.md

@@ -35,4 +35,4 @@
 
 #### Defined in
 
-[stream.ts:282](https://github.com/calebboyd/redis-x-stream/blob/d84497b/src/stream.ts#L282)
+[stream.ts:282](https://github.com/calebboyd/redis-x-stream/blob/db326b7/src/stream.ts#L282)