From 931e0c097b6ec74416a3c690d1411bcd8e9e4765 Mon Sep 17 00:00:00 2001 From: Laura Beatris <48022589+LauraBeatris@users.noreply.github.com> Date: Sun, 24 Mar 2024 17:15:16 -0300 Subject: [PATCH] Update `README.md` with SAML methods --- README.md | 15 +++++++++++++-- mix.exs | 2 +- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4c656ad..0bba8b8 100644 --- 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 index 72e45e5..b32bd0e 100644 --- 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