From 6da27ef47124dfa8ebfda9200e2dbc06d0d46e01 Mon Sep 17 00:00:00 2001 From: mffap Date: Tue, 7 Mar 2023 16:31:05 +0200 Subject: [PATCH] docs: links in readme and banner (#5390) --- README.md | 57 ++++++++++++----------------------------- docs/src/pages/index.js | 2 +- 2 files changed, 18 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index 14e9cb44c5..852d55e561 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,8 @@ With ZITADEL you can rely on a hardened and extensible turnkey solution to solve ## Get started +👉 [Quick Start Guide](https://zitadel.com/docs/guides/start/quickstart) + ### Deploy ZITADEL (Self-Hosted) Deploying ZITADEL locally takes less than 3 minutes. So go ahead and give it a try! @@ -66,14 +68,22 @@ If you want to experience a hands-free ZITADEL, you should use [ZITADEL Cloud](h It is free for up to 25'000 authenticated requests and provides you all the features that make ZITADEL great. Learn more about the [pay-as-you-go pricing](https://zitadel.com/pricing). +### Example applications + +Clone one of our [example applications](https://zitadel.com/docs/examples/introduction#clone-a-sample-project) or deploy them directly to Vercel. + +### SDKs + +Use our [SDKs](https://zitadel.com/docs/examples/sdks) for your favorite language and framework. + ## Why choose ZITADEL -We built ZITADEL with a complex multi-tenancy architecture in mind and provide the best solution to handle B2B customers and partners. -Yet it offers everything you need for a customer identity (CIAM) use case. +We built ZITADEL with a complex multi-tenancy architecture in mind and provide the best solution to handle [B2B customers and partners](https://zitadel.com/docs/guides/solution-scenarios/b2b). +Yet it offers everything you need for a customer identity ([CIAM](https://zitadel.com/docs/guides/solution-scenarios/b2c)) use case. - [API-first approach](https://zitadel.com/docs/apis/introduction) - Strong audit trail thanks to [event sourcing](https://zitadel.com/docs/concepts/eventstore/overview) as storage pattern -- [Actions](https://zitadel.com/docs/concepts/features/actions) to react on events with custom code and extended ZITADEL for you needs +- [Actions](https://zitadel.com/docs/apis/actions/introduction) to react on events with custom code and extended ZITADEL for you needs - [Branding](https://zitadel.com/docs/guides/manage/customize/branding) for a uniform user experience across multiple organizations - [Self-service](https://zitadel.com/docs/concepts/features/selfservice) for end-users, business customers, and administrators - [CockroachDB](https://www.cockroachlabs.com/) or a [Postgres](https://www.postgresql.org/) database as reliable and widespread storage option @@ -91,45 +101,12 @@ Yet it offers everything you need for a customer identity (CIAM) use case. - [Delegate role management to third-parties](https://zitadel.com/docs/guides/manage/console/projects) - [Self-registration](https://zitadel.com/docs/concepts/features/selfservice#registration) including verification - [Self-service](https://zitadel.com/docs/concepts/features/selfservice) for end-users, business customers, and administrators -- [OpenID Connect certified](https://openid.net/certification/#OPs) => [OIDC Endpoints](https://zitadel.com/docs/apis/openidoauth/endpoints), [OIDC Integration Guides](https://zitadel.com/docs/guides/integrate/auth0-oidc) -- [SAML 2.0](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html) => [SAML Endpoints](https://zitadel.com/docs/apis/saml/endpoints), [SAML Integration Guides](https://zitadel.com/docs/guides/integrate/auth0-saml) +- [OpenID Connect certified](https://openid.net/certification/#OPs) => [OIDC Endpoints](https://zitadel.com/docs/apis/openidoauth/endpoints) +- [SAML 2.0](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html) => [SAML Endpoints](https://zitadel.com/docs/apis/saml/endpoints) - [Postgres](https://zitadel.com/docs/self-hosting/manage/database#postgres) (version >= 14) or [CockroachDB](https://zitadel.com/docs/self-hosting/manage/database#cockroach) (version >= 22.0) Track upcoming features on our [roadmap](https://zitadel.com/roadmap). -## Integrate your application - -### Quickstarts - -Get started with your preferred language with our [Quickstarts](https://zitadel.com/docs/examples/introduction). - -> If you miss something please feel free to [join the Discussion](https://github.com/zitadel/zitadel/discussions/1717) - -### Example applications - -Clone one of our [example applications](https://zitadel.com/docs/examples/introduction#clone-a-sample-project) or deploy them directly to Vercel. - -### OpenID Connect RP Libraries - -Use any of the [Open ID Connect certified RP implementations](https://openid.net/developers/certified/) in your preferred language. -As certified OpenID Provider, ZITADEL is compatible with any of the implementations. - -### Client libraries - -| Language / Framework | Client | API | Machine auth (\*) | Auth check (\*\*) | Thanks to the maintainers | -|----------|--------|--------------|----------|---------|---------------------------| -| .NET | [zitadel-net](https://github.com/smartive/zitadel-net) | GRPC | ✔️ | ✔️ | [smartive 👑](https://github.com/smartive/) | -| Dart | [zitadel-dart](https://github.com/smartive/zitadel-dart) | GRPC | ✔️ | ❌ | [smartive 👑](https://github.com/smartive/) | -| Elixir | [zitadel_api](https://github.com/jshmrtn/zitadel_api) | GRPC | ✔️ | ✔️ | [jshmrtn 🙏🏻](https://github.com/jshmrtn) | -| Go | [zitadel-go](https://github.com/zitadel/zitadel-go) | GRPC | ✔️ | ✔️ | [ZITADEL](https://github.com/zitadel/) | -| Rust | [zitadel-rust](https://crates.io/crates/zitadel) | GRPC | ✔️ | ❌ | [smartive 👑](https://github.com/smartive/) | -| JVM | 🚧 [WIP](https://github.com/zitadel/zitadel/discussions/3650) | ❓ | ❓ | | TBD | -| Python | 🚧 [WIP](https://github.com/zitadel/zitadel/issues/3675) | ❓ | ❓ | | TBD | -| Javascript | ❓ | ❓ | ❓ | | Maybe you? | - -(\*) Automatically authenticate service accounts with [JWT Profile](https://zitadel.com/docs/apis/openidoauth/grant-types#json-web-token-jwt-profile). -(\*\*) Automatically check if the access token is valid and claims match - ## How To Contribute Details about how to contribute you can find in the [Contribution Guide](./CONTRIBUTING.md) @@ -151,13 +128,13 @@ Use our login widget to allow easy and secure access to your applications and en - works on all modern platforms, devices, and browsers - phishing resistant alternative - requires only one gesture by the user -- easy [enrollment](https://zitadel.com/docs/manuals/user-profile) of the device during registration +- easy enrollment of the device during registration ![passwordless-windows-hello](https://user-images.githubusercontent.com/1366906/118765435-5d419780-b87b-11eb-95bf-55140119c0d8.gif) ### Admin Console -Use [Console](https://zitadel.com/docs/manuals/introduction) or our [APIs](https://zitadel.com/docs/apis/introduction) to setup organizations, projects and applications. +Use [Console](https://zitadel.com/docs/guides/manage/console/overview) or our [APIs](https://zitadel.com/docs/apis/introduction) to setup organizations, projects and applications. [![Console Showcase](http://img.youtube.com/vi/RPpHktAcCtk/0.jpg)](http://www.youtube.com/watch?v=RPpHktAcCtk "Console Showcase") diff --git a/docs/src/pages/index.js b/docs/src/pages/index.js index 695fd896b6..6ac41179d7 100644 --- a/docs/src/pages/index.js +++ b/docs/src/pages/index.js @@ -301,7 +301,7 @@ const Gigi = () => {
-
ZITADEL Cloud OUT NOW! 🚀
+
Try ZITADEL Cloud for FREE 🚀
);