From 5dae78ff318f5dceb441c65aa82178894e4fc475 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Anders=20=C3=85berg?= <anders@andersaberg.com>
Date: Tue, 8 Aug 2023 11:07:56 +0200
Subject: [PATCH] Added initial readme

---
 README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 44 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index f1a01fe..32f9d68 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,44 @@
-# passwordless-dotnet
-Passwordless .NET SDK
+# Passwordless .NET SDK
+
+The official [Bitwarden Passwordless.dev](https://passwordless.dev/) .NET library, supporting .NET Standard 2.0+, .NET Core 2.0+ (and soon .NET Framework 4.6.1+).
+
+## Installation
+
+Using the [.NET Core command-line interface (CLI) tools][dotnet-core-cli-tools]:
+
+```sh
+dotnet add package Passwordless
+```
+
+Using the [NuGet Command Line Interface (CLI)][nuget-cli]:
+
+```sh
+nuget install Passwordless
+```
+
+Using the [Package Manager Console][package-manager-console]:
+
+```powershell
+Install-Package Passwordless
+```
+
+From within Visual Studio:
+
+1. Open the Solution Explorer.
+2. Right-click on a project within your solution.
+3. Click on *Manage NuGet Packages...*
+4. Click on the *Browse* tab and search for "Passwordless".
+5. Click on the Passwordless package, select the appropriate version in the
+   right-tab and click *Install*.
+
+## Documentation
+
+For a comprehensive list of examples, check out the [API
+documentation][api-docs]. 
+
+
+
+[api-docs]:https://docs.passwordless.dev/guide/get-started.html
+[dotnet-core-cli-tools]: https://docs.microsoft.com/en-us/dotnet/core/tools/
+[nuget-cli]: https://docs.microsoft.com/en-us/nuget/tools/nuget-exe-cli-reference
+[package-manager-console]: https://docs.microsoft.com/en-us/nuget/tools/package-manager-console