Skip to content

Commit e87c5d3

Browse files
author
Jamil Maqdis Anton
committed
Update docs
1 parent 1fc8eb9 commit e87c5d3

File tree

1 file changed

+2
-26
lines changed

1 file changed

+2
-26
lines changed

docs/README.md

Lines changed: 2 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,3 @@
1-
[![NuGet Badge](https://buildstats.info/nuget/SqlStreamStore.FSharp?includePreReleases=true)](https://www.nuget.org/packages/SqlStreamStore.FSharp/0.0.1-alpha.12)
2-
# SqlStreamStore.FSharp
1+
# SQLStreamStore.FSharp
32

4-
A thin F# wrapper around [SQLStreamStore](https://www.nuget.org/packages/SqlStreamStore), and [SqlStreamStore.Postgres](https://www.nuget.org/packages/SqlStreamStore.Postgres).
5-
6-
This library isn't intended to be an implementation of an event store on top of SqlStreamStore. It only wraps some simple functions in SqlStreamStore in F#, mostly to turn `Tasks` to `Asyncs` and offers some nice-to-haves eg. a Postgres config record type instead of a string.
7-
8-
Wrapping only the basic functionality, and sticking to the naming conventions in the original library gives the flexibility to model events, aggregates, error types, etc.. however the user sees fit.
9-
10-
11-
## Supported functionality
12-
- Connecting to Postgres
13-
- Reading a `StreamMessage`
14-
- Appending a `StreamMessage`
15-
16-
## Not Supported functionality
17-
- Subscriptions aren't going to be supported. Wrapping them is more awkward than using C# in F#.
18-
19-
## TODO
20-
21-
- ~~Postgres connector~~
22-
- ~~Read a stream message~~
23-
- ~~Write a stream message~~
24-
- ~~Subscribe to a stream~~
25-
- ~~Work on Read, and Append modules that wrap read and appends in AsyncResult type for error handeling~~
26-
- Add additional tests when Append and Read fail, and throw exceptions.
27-
- Add functionality to Read to be able to get messages directly.
3+
> A thin F# wrapper around SQLStreamStore

0 commit comments

Comments
 (0)