diff --git a/README.md b/README.md index 483c67f3771..38c15a5e634 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,20 @@ -# Generated SDKs for the ORY Ecosystem +# Generated SDKs for the Ory Ecosystem All SDKs provided in this repository are generated using openapi-generator. +## Ory Network SDKs + +When developing against [Ory Network](https://www.ory.sh/docs/sdk), use the +latest `client` or `ory-client` SDK for your preferred language. It bundles the +individual SDKs (Identities, OAuth2, Permissions) and works with [Ory API +keys](https://www.ory.sh/docs/concepts/personal-access-token). + +## Ory self-hosted SDKs + +When developing against self-hosted Ory components (Kratos, Hydra, Keto), use +the corresponding individual SDKs for your language and match the SDK version to +the version of Kratos/Hydra/Keto you have deployed. + ## Publish the Docker Image To publish the SDK Builder Docker Image, create a new GitHub release with the diff --git a/config/README.md b/config/README.md index d115a6d26b7..2e3d5bea7e5 100644 --- a/config/README.md +++ b/config/README.md @@ -2,6 +2,8 @@ This is the official Ory ${PROJECT_UCF} SDK for ${LANG}. +${NETWORK_OR_SELFHOSTED} + Please do not make any pull requests against this repository! Its contents are fully auto-generated by the [ory/sdk](http://github.com/ory/sdk) repository. Any changes to this repository will be overwritten on the next CI run! diff --git a/scripts/prep.sh b/scripts/prep.sh index 88af300b499..387f7a1f59d 100755 --- a/scripts/prep.sh +++ b/scripts/prep.sh @@ -88,6 +88,13 @@ export ELIXIR_PACKAGE_NAME="ory_${PROJECT}" export GIT_REPO="${PROJECT}-client" +export NETWORK_OR_SELFHOSTED="## Ory Self-Hosted + +This SDK is for use with self-hosted Ory ${PROJECT_UCF}. +If you are developing against Ory Network, please use the [Ory Network SDK](https://www.ory.sh/docs/sdk). + +" + if [ $project == "client" ]; then export DART_PUB_NAME=ory_client export DOTNET_PACKAGE_NAME="Ory.Client" @@ -111,4 +118,11 @@ if [ $project == "client" ]; then export ELIXIR_PACKAGE_NAME="ory_client" export GIT_REPO="client" + export NETWORK_OR_SELFHOSTED="## Ory Network + +This SDK is for use with [Ory Network](https://www.ory.sh/docs/sdk). +If you are developing aginst a self-hosted Ory instance, please use the individual ${PROJECT_UCF} SDK +and refer to the [self-hosted documentation](https://www.ory.sh/docs/sdk/self-hosted). + +" fi