From d0d8e45c35dbd4831d47fbe5f33c77a4e24e50de Mon Sep 17 00:00:00 2001 From: Marco Zocca Date: Tue, 20 Jun 2023 11:03:51 +0200 Subject: [PATCH] add common readme --- .github/workflows/haskell.yml | 2 +- README.md | 30 ++++++++++++++++++++++++++++++ 2 files changed, 31 insertions(+), 1 deletion(-) create mode 100644 README.md diff --git a/.github/workflows/haskell.yml b/.github/workflows/haskell.yml index e8fc67e..f7e238e 100644 --- a/.github/workflows/haskell.yml +++ b/.github/workflows/haskell.yml @@ -20,7 +20,7 @@ jobs: steps: - name: git checkout uses: actions/checkout@v3 - - name: (ms-graph-api) Setup compiler, build and test + - name: Setup compiler, build and test # working-directory: ./ms-graph-api run: | cd ms-azure-api/ diff --git a/README.md b/README.md new file mode 100644 index 0000000..49d9299 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# ms-api + +Haskell SDK for the Microsoft APIs: + +* Identity / Active Directory : [![Hackage](https://img.shields.io/hackage/v/ms-auth?style=for-the-badge)](https://hackage.haskell.org/package/ms-auth) +* Graph : [![Hackage](https://img.shields.io/hackage/v/ms-graph-api?style=for-the-badge)](https://hackage.haskell.org/package/ms-graph-api) +* Azure : [![Hackage](https://img.shields.io/hackage/v/ms-azure-api?style=for-the-badge)](https://hackage.haskell.org/package/ms-azure-api) + + +## Status + +This library is still in development, so expect missing functionality. +If there's anything you would like to see added, feel free to +[open an issue](https://github.com/unfoldml/ms-graph-api/issues/new), or even better contribute some code. +In general, since the API surface is quite large, features will be added to this library on a need basis. + +## 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 ). + + +## LICENSE + +BSD 3 + +## Copyright + +(c) 2023-, Marco Zocca, UnfoldML AB