From 0e10894f941bb623db5a75b91d12a13234bf3e82 Mon Sep 17 00:00:00 2001
From: Ulf Gebhardt <ulf.gebhardt@webcraft-media.de>
Date: Fri, 18 Dec 2020 15:09:25 +0100
Subject: [PATCH] updated readme

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/README.md b/README.md
index 320f72d..3100c93 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,30 @@
 # js-wowemu-auth
 SRP implementation for WoW Server authentication in Typescript
+
+## installation
+
+```
+yarn add js-wowemu-auth
+```
+
+## usage
+
+### register
+
+```ts
+import { register } from 'js-wowemu-auth'
+
+register('user', 'password')
+```
+
+This will return
+```ts
+{
+  salt: "63f86e2b89cec2f95d1d67abd7148309787b98847c55f6e68fcfdaebdadcc505",
+  verifier: "636a2087700468caded99874ea45cee20e2b70a7a7edf522d8e6eb0f1a1b15fc"
+}
+```
+
+`username` is to be set to the column `username` in `realm.account`
+`salt` is to be set to the column `s` in `realm.account`
+`verifier`is to be set to the column `v` in `realm.account`
\ No newline at end of file