Skip to content

Commit 2d0ab12

Browse files
committed
Readme fixes
Signed-off-by: Matteo Collina <[email protected]>
1 parent c9eb012 commit 2d0ab12

File tree

1 file changed

+4
-12
lines changed

1 file changed

+4
-12
lines changed

README.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,9 @@ redis.zrange("sortedSet", 0, 2, "WITHSCORES").then((elements) => {
8383
console.log(elements);
8484
});
8585

86-
// All arguments are passed directly to the redis server,
86+
// All arguments are passed directly to the valkey/redis server,
8787
// so technically iovalkey supports all Redis commands.
88-
// The format is: redis[SOME_REDIS_COMMAND_IN_LOWERCASE](ARGUMENTS_ARE_JOINED_INTO_COMMAND_STRING)
88+
// The format is: redis[SOME_VALKEY_COMMAND_IN_LOWERCASE](ARGUMENTS_ARE_JOINED_INTO_COMMAND_STRING)
8989
// so the following statement is equivalent to the CLI: `redis> SET mykey hello EX 10`
9090
redis.set("mykey", "hello", "EX", 10);
9191
```
@@ -101,7 +101,7 @@ See the `examples/` folder for more examples. For example:
101101
- [Streams](examples/stream.js)
102102
- [Redis Modules](examples/module.js) e.g. RedisJSON
103103

104-
All Redis commands are supported. See [the documentation](https://redis.github.io/iovalkey/classes/Redis.html) for details.
104+
All Redis commands are supported. See [the documentation](https://valkey.github.io/iovalkey/classes/Redis.html) for details.
105105

106106
## Connect to Redis
107107

@@ -1352,16 +1352,14 @@ default, this option is disabled and can only be used for debugging purposes. Yo
13521352

13531353
# Running tests
13541354

1355-
Start a Redis server on 127.0.0.1:6379, and then:
1355+
Start a Valkey/Redis server on 127.0.0.1:6379, and then:
13561356

13571357
```shell
13581358
npm test
13591359
```
13601360

13611361
`FLUSH ALL` will be invoked after each test, so make sure there's no valuable data in it before running tests.
13621362

1363-
If your testing environment does not let you spin up a Redis server [iovalkey-mock](https://github.com/stipsan/iovalkey-mock) is a drop-in replacement you can use in your tests. It aims to behave identically to iovalkey connected to a Redis server so that your integration tests is easier to write and of better quality.
1364-
13651363
# Debug
13661364

13671365
You can set the `DEBUG` env to `iovalkey:*` to print debug info:
@@ -1376,12 +1374,6 @@ I'm happy to receive bug reports, fixes, documentation enhancements, and any oth
13761374

13771375
And since I'm not a native English speaker, if you find any grammar mistakes in the documentation, please also let me know. :)
13781376

1379-
# Contributors
1380-
1381-
This project exists thanks to all the people who contribute:
1382-
1383-
<a href="https://github.com/mcollina/iovalkey/graphs/contributors"><img src="https://opencollective.com/iovalkey/contributors.svg?width=890&showBtn=false" /></a>
1384-
13851377
# License
13861378

13871379
MIT

0 commit comments

Comments
 (0)