diff --git a/README.md b/README.md index 64b00e9..828bf3b 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,25 @@ # Aurora +[![CI](https://github.com/microsoft/Aurora/actions/workflows/ci.yaml/badge.svg)](https://github.com/microsoft/Aurora/actions/workflows/ci.yaml) +[![Latest documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://microsoft.github.io/aurora) + Implementation of the Aurora model. + +[Link to the documentation.](https://microsoft.github.io/aurora) + + +## Getting Started + +Install with `pip`: + +```bash +pip install microsoft-aurora +``` + +Example here. + + +## FAQ + +FAQ.