Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Marco Zocca committed Jun 19, 2023
1 parent 11fce44 commit 28001c5
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
28 changes: 28 additions & 0 deletions ms-auth/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# ms-auth

Haskell client bindings to the [Microsoft Identity / Active Directory API]().

[![Hackage](https://img.shields.io/hackage/v/ms-auth?style=for-the-badge)](https://hackage.haskell.org/package/ms-auth)

![main](https://github.com/unfoldml/ms-graph-api/actions/workflows/haskell.yml/badge.svg?branch=main)


## Introduction

This library provides helpers for building token-based authentication flows e.g. Client Credentials (App-only) and On-Behalf-Of (Delegated), as well as for keeping tokens up to date in the background.


## Status

This library is functional but still in development.

## Evolution of the library

Some breaking changes might also be introduced as the library matures.

We adhere to a simplified version of the [Package Versioning Policy](https://pvp.haskell.org/): breaking changes are signaled by increasing the major version number (e.g. 0.x -> 1.x ).


## Copyright

(c) 2023-, Marco Zocca, UnfoldML AB
2 changes: 1 addition & 1 deletion ms-auth/ms-auth.cabal
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: ms-auth
version: 0.1.0.0
version: 0.2.0.0
synopsis: Microsoft Authentication API
description: Bindings to the Microsoft Identity API / Active Directory (AD) for building applications that use either Delegated or App-only permissions. Helper functions are provided for building OAuth2 authentication flows and keep tokens transactionally secure and up to date.
homepage: https://github.com/unfoldml/ms-auth
Expand Down

0 comments on commit 28001c5

Please sign in to comment.