Skip to content

Commit d780b91

Browse files
committed
Adding link to docs
1 parent f9dcfcf commit d780b91

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44

55
[![Test](https://github.com/bfren/rqlite/actions/workflows/test.yml/badge.svg)](https://github.com/bfren/rqlite/actions/workflows/test.yml) ![Publish](https://github.com/bfren/rqlite/workflows/Publish/badge.svg)
66

7-
Unofficial .NET client for [Rqlite](https://rqlite.io).
7+
Unofficial .NET client for [Rqlite](https://rqlite.io), download [NuGet package](https://nuget.org/packages/rqlite).
8+
9+
Documentation (including API explorer) is available [here](https://bfren.github.io/rqlite).
810

911
## Features
1012

@@ -20,10 +22,14 @@ Unofficial .NET client for [Rqlite](https://rqlite.io).
2022
The simplest way to start testing is to use [Docker](https://docker.com):
2123

2224
```bash
23-
docker run -p4001:4001 rqlite/rqlite
25+
# start rqlite instance using Docker
26+
$ ./run.sh
27+
28+
# in a new terminal
29+
$ dotnet run --project apps/ReadmeApp/ReadmeApp.csproj
2430
```
2531

26-
Install the [NuGet package](https://nuget.org/packages/rqlite). You can see a functioning example of the code below in the ReadmeApp project of this repository.
32+
This will execute the code below (taken from ReadmeApp's `Project.cs` file). You can see additional options and code in the ConsoleApp project.
2733

2834
```csharp
2935
// register Rqlite with dependency injection

0 commit comments

Comments
 (0)