Skip to content

Commit 5baab1c

Browse files
author
Jimmy Byrd
committed
Initial rough documentation
1 parent 976f9d3 commit 5baab1c

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# FSharp.Control.Redis.Streams
22

3-
[Enter useful description for FSharp.Control.Redis.Streams]
3+
FSharp.Control.Redis.Streams is a library dedicated to bridging [Redis Streams](https://redis.io/topics/streams-intro) with .NET Streaming technologies.
4+
5+
Currently Supported:
6+
7+
- [Hopac Streams](https://hopac.github.io/Hopac/Hopac.html#def:module%20Hopac.Stream)
8+
- [Akka.net Streams](https://getakka.net/articles/streams/introduction.html)
9+
- [Reactive Extensions](http://reactivex.io/)
410

511
---
612

@@ -31,6 +37,16 @@ Make sure the following **requirements** are installed in your system:
3137

3238
* [dotnet SDK](https://www.microsoft.com/net/download/core) 2.0 or higher
3339
* [Mono](http://www.mono-project.com/) if you're on Linux or macOS.
40+
* [docker-compose](https://docs.docker.com/compose/)
41+
42+
43+
Stand up redis via docker:
44+
45+
```sh
46+
docker-compose up
47+
```
48+
49+
Build:
3450

3551
```
3652
> build.cmd // on windows

0 commit comments

Comments
 (0)