initial readme, drafter update (#9)

Author: chayim

.github/release-drafter-config.yml

@@ -1,5 +1,5 @@
-name-template: 'Version $NEXT_PATCH_VERSION'
-tag-template: 'v$NEXT_PATCH_VERSION'
+name-template: '$NEXT_MAJOR_VERSION'
+tag-template: 'v$NEXT_MAJOR_VERSION'
 autolabeler:
   - label: 'maintenance'
     files:
@@ -15,9 +15,13 @@ autolabeler:
     branch:
       - '/feature-.+'
 categories:
-  - title: '🔥 Breaking Changes'
+  - title: 'Breaking Changes'
     labels:
       - 'breakingchange'
+
+  - title: '🧪 Experimental Features'
+    labels:
+      - 'experimental'
   - title: '🚀 New Features'
     labels:
       - 'feature'
@@ -27,6 +31,7 @@ categories:
       - 'fix'
       - 'bugfix'
       - 'bug'
+      - 'BUG'
   - title: '🧰 Maintenance'
     label: 'maintenance'
 change-template: '- $TITLE (#$NUMBER)'

.github/wordlist.txt

@@ -1,58 +1,5 @@
-APIs
-Bader's
-CLI
-Config
-Deserializing
-FastAPI
-HashModel
-Homebrew
-JSON
-JsonModel
-MacOS
-OM's
-ORM
-Pipenv
-PrimaryKeyCreator
-Pydantic
-Pydantic
-Pydantic's
-README
-README.md
-RediSearch
-RediSearch
-RedisJSON
-SQLAlchemy
-SSL
-TOC
-ULIDs
-UlidPrimaryKey
-WSL
-aioredis
-async
-asyncio
-cls
-coroutines
-doctoc
-fastapi
-indexable
-io
-js
-localhost
-md
-migrator
-py
-pyenv
-redis
-redisearch
-redisjson
-rediss
-runtime
-sortable
-subclasses
-subclassing
-subscripted
-unix
-utf
-validator
-validators
-virtualenv
+StackExchange
+NRedisStack
+github
+yml
+Codecov

.github/workflows/integration.yml

@@ -1,3 +1,5 @@
+Name: Integration Tests
+
 on:
   push:
     paths-ignore:
@@ -15,7 +17,7 @@ env:
 jobs:
 
   build_and_test:
-    name: Build and Test
+    name: Build and test [dotnet ${{matrix.dotnet-version}}]
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -31,4 +33,4 @@ jobs:
       - name: compile
         run: dotnet build
       - name: run tests
-        run: dotnet test
+        run: dotnet test

LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2020, RedisTimeSeries
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,17 @@
+[![license](https://img.shields.io/github/license/RedisTimeSeries/NRedisTimeSeries.svg)](https://github.com/RedisTimeSeries/NRedisTimeSeries)
+[![.github/workflows/integration.yml](https://github.com/redis/NRedisStack/actions/workflows/integration.yml/badge.svg)](https://github.com/redis/NRedisStack/actions/workflows/integration.yml)
+[![GitHub issues](https://img.shields.io/github/release/RedisTimeSeries/NRedisTimeSeries.svg)](https://github.com/RedisTimeSeries/NRedisTimeSeries/releases/latest)
+[![Codecov](https://codecov.io/gh/RedisTimeSeries/NRedisTimeSeries/branch/master/graph/badge.svg)](https://codecov.io/gh/RedisTimeSeries/NRedisTimeSeries)
+[![Known Vulnerabilities](https://snyk.io/test/github/redis/NRedisStack/badge.svg?targetFile=NRedisStack/NRedisStack.csproj)](https://snyk.io/test/github/RedisTimeSeries/NRedisTimeSeries?targetFile=NRedisTimeSeries/NRedisTimeSeries.csproj)
+
+# NRedisStack
+
+.NET Client for Redis
+
+## Note
+
+This project builds on [StackExchange.Redis](https://github.com/StackExchange/StackExchange.Redis), and seeks to bring native support for Redis Modules to the C# ecosystem.
+
+## API
+
+The complete documentation for Redis  module commands can be found at the [Redis commands website](https://redis.io/commands/).