diff --git a/README.md b/README.md index 71afe7c9a..ff7980261 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Canonical authd +# authd: an authentication daemon for cloud identity providers [actions-image]: https://github.com/ubuntu/authd/actions/workflows/qa.yaml/badge.svg [actions-url]: https://github.com/ubuntu/authd/actions?query=workflow%3AQA @@ -24,8 +24,8 @@ Authd is an authentication daemon for cloud-based identity providers. It helps ensure the secure management of identity and access for Ubuntu machines anywhere in the world, on desktop and the server. Authd's modular design makes it a versatile authentication service that can integrate with multiple identity -providers. MS Entra ID is currently supported and support for several other -identity providers is under active development. +providers. MS Entra ID is currently supported and several other +identity providers are under active development. ## Documentation @@ -44,14 +44,16 @@ Authd uses brokers to interface with cloud identity providers through a [DBus AP Currently [MS Entra ID](https://learn.microsoft.com/en-us/entra/fundamentals/whatis) is supported as an identity provider. The [MS Entra ID broker](https://github.com/ubuntu/oidc-broker) allows you to authenticate against MS Entra ID using MFA and the device authentication flow. -For development purposes, authd also provides an example broker to help you develop your own. +For development purposes, authd also provides an [example broker](https://github.com/ubuntu/authd/tree/main/examplebroker) to help you develop your own. ## Get involved -This is an [open source](COPYING) project and we warmly welcome community contributions, suggestions, and constructive feedback. If you're interested in contributing, please take a look at our [Contribution guidelines](CONTRIBUTING.md) first. +This is an [open source](COPYING) project and we warmly welcome community contributions, suggestions, and constructive feedback. If you're interested in contributing, please take a look at our [contribution guidelines](CONTRIBUTING.md) first. -- To report an issue, please file a bug report against our repository, using the **report an issue** template. -- For suggestions and constructive feedback, report a feature request bug report, using the **request a feature** template. +When reporting an issue you can [choose from several templates](https://github.com/ubuntu/authd/issues/new/choose): + +- To report an issue, please file a bug report against our repository, using the [report an issue](https://github.com/ubuntu/authd/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml&title=Issue%3A+) template. +- For suggestions and constructive feedback, report a feature request bug report, using the [request a feature](https://github.com/ubuntu/authd/issues/new?assignees=&labels=feature&projects=&template=feature_request.yml&title=Feature%3A+) template. ## Get in touch