Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
matheusfm committed Oct 26, 2023
1 parent 3cf2876 commit 290cf67
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,24 @@

## Introduction

Zora is a multi-cluster scan that helps you identify potential issues and vulnerabilities
in your Kubernetes clusters in a centralized way, ensuring that the recommended best practices are in place.
Zora is an open-source solution that helps you achieve compliance with Kubernetes best practices recommended by
industry-leading frameworks.

Zora is the first product created by Undistro's initiative. Visit our [website](https://undistro.io) for more information about the project and sign up for our newsletter to stay up to date with Zora's new features and Undistro's new initiatives.
By scanning your cluster with multiple plugins at scheduled times, Zora identifies potential issues, misconfigurations,
and vulnerabilities.

_Please [star :star:](https://github.com/undistro/zora/stargazers) the repo if you want us to continue developing and improving Zora!_ :grin:

## Getting Started

Check out our live [documentation](https://zora-docs.undistro.io) for details about how to install Zora and start to scan your clusters.

## Contributing

We are in alpha stage and we'd love it if you contributed to Zora. For information on contributing to this project, please see our [guideline](https://github.com/undistro/zora/blob/main/CONTRIBUTING.md).
Please refer to the [contributing guide](https://github.com/undistro/zora/blob/main/CONTRIBUTING.md) and the
[code of conduct](https://github.com/undistro/zora/blob/main/CODE_OF_CONDUCT.md)
for more information on how to contribute.

## License

Zora is a Undistro product, backed by [Getup.io](https://getup.io) under the [Apache License 2.0](LICENSE).
Zora is released under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details.

0 comments on commit 290cf67

Please sign in to comment.