You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Changing 'Modules' to 'Stack'
* Adding installation & getting started guide
* Update Docker
* Add redis logo image
* Add Search Example
* Fixes after review
* Add words to wordlist
Copy file name to clipboardExpand all lines: README.md
+69-7
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@
9
9
10
10
## Note
11
11
12
-
This project builds on [StackExchange.Redis](https://github.com/StackExchange/StackExchange.Redis), and seeks to bring native support for Redis Modules to the C# ecosystem.
12
+
This project builds on [StackExchange.Redis](https://github.com/StackExchange/StackExchange.Redis), and seeks to bring native support for Redis Stack commands to the C# ecosystem.
13
13
14
14
## API
15
15
@@ -18,15 +18,35 @@ The complete documentation for Redis module commands can be found at the [Redis
18
18
### Redis OSS commands
19
19
You can use Redis OSS commands in the same way as you use them in [StackExchange.Redis](https://github.com/StackExchange/StackExchange.Redis).
20
20
21
-
### Modules Commands
21
+
### Stack commands
22
22
Each module has a command class with its own commands.
23
-
The supported modules are:[Search](https://redis.io/commands/?group=search), [Json](https://redis.io/commands/?group=json), [Graph](https://redis.io/commands/?group=graph), [TimeSeries](https://redis.io/commands/?group=timeseries), [Bloom Filter](https://redis.io/commands/?group=bf), [Cuckoo Filter](https://redis.io/commands/?group=cf), [T-Digest](https://redis.io/commands/?group=tdigest), [Count-min Sketch](https://redis.io/commands/?group=cms) and [Top-K](https://redis.io/commands/?group=topk).
23
+
The supported modules are [Search](https://redis.io/commands/?group=search), [JSON](https://redis.io/commands/?group=json), [Graph](https://redis.io/commands/?group=graph), [TimeSeries](https://redis.io/commands/?group=timeseries), [Bloom Filter](https://redis.io/commands/?group=bf), [Cuckoo Filter](https://redis.io/commands/?group=cf), [T-Digest](https://redis.io/commands/?group=tdigest), [Count-min Sketch](https://redis.io/commands/?group=cms), and [Top-K](https://redis.io/commands/?group=topk).
24
24
25
25
# Usage
26
26
27
-
First, you need to connect to Redis, exactly the same way you do it in [StackExchange.Redis](https://github.com/StackExchange/StackExchange.Redis):
27
+
## 💻 Installation
28
+
29
+
Using the dotnet cli, run:
30
+
31
+
```text
32
+
dotnet add package NRedisStack
33
+
```
34
+
35
+
## 🏁 Getting started
36
+
37
+
### Starting Redis
38
+
39
+
Before writing any code, you'll need a Redis instance with the appropriate Redis modules. The quickest way to get this is with Docker:
40
+
41
+
```sh
42
+
docker run -p 6379:6379 --name redis-stack redis/redis-stack:latest
43
+
```
44
+
45
+
This launches [Redis Stack](https://redis.io/docs/stack/), an extension of Redis that adds modern data structures to Redis.
46
+
47
+
Now, you need to connect to Redis, exactly the same way you do it in [StackExchange.Redis](https://github.com/StackExchange/StackExchange.Redis):
0 commit comments