Updated Readme.md

Author: codingstill

Readme.md

@@ -1,7 +1,9 @@
-# JWT RSA C# library
+# JWT C# library
 
 A C# class that can sign and validate JWT tokens, wrapped in a simple library with a couple of helper functions.
 
+## RSA Algorithm
+
 To generate a compatible private key
 ```
 openssl genrsa -out private.key 4096
@@ -12,7 +14,7 @@ To generate a compatible public key
 openssl rsa -in private.key -outform PEM -pubout -out public.pem
 ```
 
-## Sign a JWT token
+### Sign a JWT token
 ```cs
 using Newtonsoft.Json;
 
@@ -27,13 +29,13 @@ string signedToken = jwt.Sign(strToken);
 ```
 In case of an error, an Exception will be thrown.
 
-## Validate a JWT token
+### Validate a JWT token
 ```cs
 using Newtonsoft.Json;
 
 JwtManager.RsJwt jwt = new JwtManager.RsJwt
 {
- KeySize = JwtManager.Helpers.KeySize.S256, // This can be also 384 or 512
+ KeySize = JwtManager.Helpers.KeySize.S256, // This can be also S384 or S512
  PublicKey = PublicKey
 };
 
@@ -43,6 +45,48 @@ var myToken = JsonConvert.DeserializeObject<JwtToken>(payload);
 
 In case of an error, an Exception will be thrown.
 
+
+## HMAC Algorithm
+
+For this you need a secret in store it in a string variable. Use a longer secret for better security
+
+### Sign a JWT token
+```cs
+using Newtonsoft.Json;
+
+string secret = "setyourverysecretkeyhere";
+
+JwtManager.HsJwt jwt = new JwtManager.HsJwt
+{
+ KeySize = JwtManager.Helpers.KeySize.S256, // This can be also 384 or 512
+ Secret = secret
+};
+
+string strToken = JsonConvert.SerializeObject(myToken);
+string signedToken = jwt.Sign(strToken);
+```
+In case of an error, an Exception will be thrown.
+
+### Validate a JWT token
+```cs
+using Newtonsoft.Json;
+
+string secret = "setyourverysecretkeyhere";
+
+JwtManager.HsJwt jwt = new JwtManager.HsJwt
+{
+ KeySize = JwtManager.Helpers.KeySize.S256, // This can be also S384 or S512
+ Secret = secret
+};
+
+string payload = jwt.Validate(strToken);
+var myToken = JsonConvert.DeserializeObject<JwtToken>(payload);
+```
+
+In case of an error, an Exception will be thrown.
+
+## Other Info
+
 The code has been tested both as a .NET and .NET Core library.
 
 Check the JwtManagerTests project on more examples on how to use