Add docsify docs and see how they look.

Jamil Maqdis Anton · Jamil Maqdis Anton · commit 9e3a0be35822 · 2020-10-24T14:08:35.000+02:00
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,27 @@
+[![NuGet Badge](https://buildstats.info/nuget/SqlStreamStore.FSharp?includePreReleases=true)](https://www.nuget.org/packages/SqlStreamStore.FSharp/0.0.1-alpha.12)
+# SqlStreamStore.FSharp
+
+A thin F# wrapper around [SQLStreamStore](https://www.nuget.org/packages/SqlStreamStore), and [SqlStreamStore.Postgres](https://www.nuget.org/packages/SqlStreamStore.Postgres).
+
+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.
+
+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.
+
+
+## Supported functionality
+- Connecting to Postgres
+- Reading a `StreamMessage`
+- Appending a `StreamMessage`
+
+## Not Supported functionality
+- Subscriptions aren't going to be supported. Wrapping them is more awkward than using C# in F#.
+
+## TODO
+
+- ~~Postgres connector~~
+- ~~Read a stream message~~
+- ~~Write a stream message~~
+- ~~Subscribe to a stream~~
+- ~~Work on Read, and Append modules that wrap read and appends in AsyncResult type for error handeling~~
+- Add additional tests when Append and Read fail, and throw exceptions.
+- Add functionality to Read to be able to get messages directly.
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Document</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: '',
+      repo: ''
+    }
+  </script>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
+</body>
+</html>
