add docs

.github/workflows/build.yaml

@@ -51,7 +51,7 @@ jobs:
         msbuild /restore ${{ env.VSIX_PROJECT }} /p:Configuration=Release /p:OutDir=${{ github.workspace }}\artifacts
 
     - name: Push to GitHub Packages
-      run: nuget push ${{ github.workspace }}\artifacts\*.nupkg -Source "Github"
+      run: nuget push ${{ github.workspace }}\artifacts\*.nupkg -Source "Github" -SkipDuplicate
 
     # upload artifacts
     - name: Upload artifacts

README.md

@@ -1,8 +1,10 @@
 # Elasticsearch .NET Playground
 
-This playground is a collection of notebooks that demonstrate how to use Elasticsearch.NET and NEST clients.
+This playground is a collection of notebooks that demonstrate how to use `Elastic.Clients.Elasticsearch` and `NEST` clients.
 
-You may want to use this playground to learn more about Elasticsearch.NET and NEST clients or if you want to migration your existing code from NEST to Elasticsearch.NET.
+You may want to use this playground to:
+* Learn more about `Elastic.Clients.Elasticsearch` and `NEST` clients
+* You want to migrate your existing code from `NEST` to `Elastic.Clients.Elasticsearch`.
 
 > See [playground.ipynb](./playground.ipynb) to get started.
 
@@ -12,6 +14,14 @@ You may want to use this playground to learn more about Elasticsearch.NET and NE
 
 To configure the playground, set the `PLAYGROUND_CONNECTION_STRING=https://elastic:[email protected]:9200/` in .env file in the root of the project. If you don't do it, you will be prompted to enter the connection string every time you set up the client
 
+## Analyzer
+
+This repository contains [Nall.NEST.MigtarionAnalyzer](https://github.com/NikiforovAll/elasticsearch-dotnet-playground/pkgs/nuget/Nall.NEST.MigtarionAnalyzer) analyzer that helps with migration from `Nest` to `Elastic.Clients.Elasticsearch`.
+
+```bash
+dotnet add package Nall.NEST.MigtarionAnalyzer --version 1.0.0
+```
+
 ## Devcontainer
 
 You can use the devcontainer to get started with the playground. It will install the required tools and libraries.

analyzer/README.md

@@ -1,9 +1,10 @@
 # Nall.NEST.MigtarionAnalyzer
 
-This package helps with migration from Nest to Elastic.Clients.Elasticsearch
+This package helps with migration from `Nest` to `Elastic.Clients.Elasticsearch`
 
 ```bash
 dotnet format analyzers ./path/to/folder \
     --verify-no-changes \
     --diagnostics ELS001 \
-    --severity info
+    --severity info
+```