From 15f70a35b45e737ca9039d83327da4bdad1ec09c Mon Sep 17 00:00:00 2001 From: Emmanuel Gautier Date: Sun, 29 Sep 2024 12:38:01 +0200 Subject: [PATCH] chore: add readme --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2803b88 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# cerberauth/x + +[![GoDoc reference](https://img.shields.io/badge/godoc-reference-5272B4.svg?style=for-the-badge)](https://godoc.org/github.com/cerberauth/x) +[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/cerberauth/x/ci.yml?branch=main&label=core%20build&style=for-the-badge)](https://github.com/cerberauth/x/actions/workflows/ci.yml) +[![Go Report Card](https://goreportcard.com/badge/github.com/cerberauth/x?style=for-the-badge)](https://goreportcard.com/report/github.com/cerberauth/x) + +Shared libraries used in the CerberAuth ecosystem. Use at your own risk. Breaking changes should be anticipated. + +## License + +This repository is licensed under the [MIT License](https://github.com/cerberauth/x/blob/main/LICENSE) @ [CerberAuth](https://www.cerberauth.com/). You are free to use, modify, and distribute the contents of this repository for educational and testing purposes.