chore: add readme

cerberauth · Sep 29, 2024 · 15f70a3 · 15f70a3
1 parent d0ec204
commit 15f70a3
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md 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.