docs: Updated README.md (#6795)

Updated README.md

I updated the existing Read.me file adding checkmarks for easier reading. I also adjusted some sentences for better grammatical meaning.

The overall purpose of these actions is to improve user and customer experience and understanding.

Co-authored-by: Fabi <fabienne@zitadel.com>
This commit is contained in:
Justice Chinedu 2023-10-25 08:23:06 +01:00 committed by GitHub
parent 93122efe9f
commit 1fafefc2c1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -30,16 +30,37 @@
<img src="./docs/static/logos/oidc-cert.png" /></a>
</p>
Do you look for a user management that's quickly set up like Auth0 and open source like Keycloak?
Are you searching for a user management tool that is quickly set up like Auth0 and open source like Keycloak?
Do you have a project that requires multi-tenant user management with self-service for your customers?
Look no further — ZITADEL is the identity infrastructure, simplified for you.
We provide you with a wide range of out-of-the-box features to accelerate your project.
Multi-tenancy with branding customization, secure login, self-service, OpenID Connect, OAuth2.x, SAML2, LDAP, Passkeys / FIDO2, OTP, U2F, and an unlimited audit trail is there for you, ready to use.
We provide you with a wide range of out-of-the-box features to accelerate your project, including:
With ZITADEL you can rely on a hardened and extensible turnkey solution to solve all of your authentication and authorization needs.
:white_check_mark: Multi-tenancy with branding customization
:white_check_mark: Secure login
:white_check_mark: Self-service
:white_check_mark: OpenID Connect
:white_check_mark: OAuth2.x
:white_check_mark: SAML2
:white_check_mark: LDAP
:white_check_mark: Passkeys / FIDO2
:white_check_mark: OTP
:white_check_mark: U2F, and an unlimited audit trail is there for you, ready to use.
With ZITADEL, you are assured of a robust and customizable turnkey solution for all your authentication and authorization needs.
---
@ -51,7 +72,7 @@ With ZITADEL you can rely on a hardened and extensible turnkey solution to solve
### Deploy ZITADEL (Self-Hosted)
Deploying ZITADEL locally takes less than 3 minutes. So go ahead and give it a try!
Deploying ZITADEL locally takes less than 3 minutes. Go ahead and give it a try!
* [Linux](https://zitadel.com/docs/self-hosting/deploy/linux)
* [MacOS](https://zitadel.com/docs/self-hosting/deploy/macos)
@ -67,7 +88,7 @@ See all guides [here](https://zitadel.com/docs/self-hosting/deploy/overview)
If you want to experience a hands-free ZITADEL, you should use [ZITADEL Cloud](https://zitadel.cloud).
ZITADEL Cloud comes with a free tier and provides you all the features that you find in the open source version.
ZITADEL Cloud comes with a free tier, providing you with all the same features as the open-source version.
Learn more about the [pay-as-you-go pricing](https://zitadel.com/pricing).
### Example applications
@ -129,7 +150,7 @@ Track upcoming features on our [roadmap](https://zitadel.com/roadmap).
## How To Contribute
Details about how to contribute you can find in the [Contribution Guide](./CONTRIBUTING.md)
Find details about how you can contribute in our [Contribution Guide](./CONTRIBUTING.md)
## Contributors
@ -161,13 +182,13 @@ Use [Console](https://zitadel.com/docs/guides/manage/console/overview) or our [A
## Security
See the policy [here](./SECURITY.md).
You can find our security policy [here](./SECURITY.md).
[Technical Advisories](https://zitadel.com/docs/support/technical_advisory) are published regarding major issues with the ZITADEL platform that could potentially impact security or stability in production environments.
## License
See the exact licensing terms [here](./LICENSE)
[here](./LICENSE) are our exact licensing terms.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and limitations under the License.
See our [license](./LICENSE) for detailed information governing permissions and limitations on use.