Update README.md with SAML methods

LauraBeatris · Mar 24, 2024 · 931e0c0 · 931e0c0
1 parent a0372b0
commit 931e0c0
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -59,8 +59,19 @@ Here's a list of error per tags:
 
 ### `decode_saml_response`
 
-Work in progress.
+Parsed a given SAML response to a struct: 
+
+```ex
+iex(1)> ShinAuth.SAML.decode_saml_response(valid_saml_response)
+{:ok, %ShinAuth.SAML.Response{}}
+```
 
 ### `decode_saml_request`
 
-Work in progress.
+Parsed a given SAML request to a struct: 
+
+```ex
+iex(1)> ShinAuth.SAML.decode_saml_request(valid_saml_request)
+{:ok, %ShinAuth.SAML.Request{}}
+```
+
diff --git a/mix.exs b/mix.exs
@@ -38,7 +38,7 @@ defmodule Shin.MixProject do
       source_ref: "v#{@version}",
       canonical: "https://hexdocs.pm/shin_auth",
       source_url: @source_url,
-      extras: ["README.md", "CHANGELOG.md", "LICENSE"]
+      extras: ["README.md", "LICENSE"]
     ]
   end