diff --git a/Directory.Packages.props b/Directory.Packages.props index 0b2a8a7..9386e61 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -13,10 +13,10 @@ - + - - + + \ No newline at end of file diff --git a/README.md b/README.md index d11b6c3..e7ffc3f 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ [![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) -Unofficial .NET client for [Rqlite](https://rqlite.io). +Unofficial .NET client for [Rqlite](https://rqlite.io), download [NuGet package](https://nuget.org/packages/rqlite). + +Documentation (including API explorer) is available [here](https://bfren.github.io/rqlite). ## Features @@ -20,10 +22,14 @@ Unofficial .NET client for [Rqlite](https://rqlite.io). The simplest way to start testing is to use [Docker](https://docker.com): ```bash -docker run -p4001:4001 rqlite/rqlite +# start rqlite instance using Docker +$ ./run.sh + +# in a new terminal +$ dotnet run --project apps/ReadmeApp/ReadmeApp.csproj ``` -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. +This will execute the code below (taken from ReadmeApp's `Project.cs` file). You can see additional options and code in the ConsoleApp project. ```csharp // register Rqlite with dependency injection diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..4378419 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,9 @@ +############### +# folder # +############### +/**/DROP/ +/**/TEMP/ +/**/packages/ +/**/bin/ +/**/obj/ +_site diff --git a/docs/api/.gitignore b/docs/api/.gitignore new file mode 100644 index 0000000..e8079a3 --- /dev/null +++ b/docs/api/.gitignore @@ -0,0 +1,5 @@ +############### +# temp file # +############### +*.yml +.manifest diff --git a/docs/api/index.md b/docs/api/index.md new file mode 100644 index 0000000..78dc9c0 --- /dev/null +++ b/docs/api/index.md @@ -0,0 +1,2 @@ +# PLACEHOLDER +TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*! diff --git a/docs/articles/index.md b/docs/articles/index.md new file mode 100644 index 0000000..c0478ce --- /dev/null +++ b/docs/articles/index.md @@ -0,0 +1 @@ +# Add your introductions here! diff --git a/docs/articles/toc.yml b/docs/articles/toc.yml new file mode 100644 index 0000000..ff89ef1 --- /dev/null +++ b/docs/articles/toc.yml @@ -0,0 +1,2 @@ +- name: Introduction + href: intro.md diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..3ae2506 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,4 @@ +# This is the **HOMEPAGE**. +Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files. +## Quick Start Notes: +1. Add images to the *images* folder if the file is referencing an image. diff --git a/docs/toc.yml b/docs/toc.yml new file mode 100644 index 0000000..59f8010 --- /dev/null +++ b/docs/toc.yml @@ -0,0 +1,5 @@ +- name: Articles + href: articles/ +- name: Api Documentation + href: api/ + homepage: api/index.md