Change logo - modify READMEs

brando-dill · brando-dill · commit cb418a6d14ff · 2024-12-20T15:47:44.000-05:00
Initial PR to update the Logos in the README files to not point to one displaying ForgeRock.

Updated READMEs to be more consistent, added a section for OIDC Login, and added a blurb at the top of each read me about embedded versus OIDC as this is a question from the field.

Update README based on feedback

Also added OIDC for Android and iOS, as well as DaVinci in the READMEs.

Update README based on feedback

Also added OIDC for Android and iOS, as well as DaVinci in the READMEs.

Update README.md
diff --git a/.idea/.gitignore b/.idea/.gitignore
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/.idea/sdk-sample-apps.iml b/.idea/sdk-sample-apps.iml
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://github.com/ForgeRock/sdk-sample-apps">
-    <img src="https://cdn.forgerock.com/logo/interim/Logo-PingIdentity-ForgeRock-Hor-FullColor.svg" alt="Logo">
+    <img src="https://www.pingidentity.com/content/dam/picr/nav/Ping-Logo-2.svg" alt="Ping Identity Logo">
   </a>
   <hr/>
 </p>
@@ -9,25 +9,26 @@
 
 Ping provides these samples to help demonstrate SDK functionality/implementation. They are provided "as is" and are not official products of Ping and are not officially supported.
 
-### Integrate with PingOne Advanced Identity Cloud / PingAM:
+Our samples showcase functionality of our SDKs to get you up and running,
+whether you are using PingOne Advanced Identity Cloud, PingAM,
+OIDC (Redirect) Login, or PingOne DaVinci, we've got you covered.
+
+Explore the many use cases
+the Ping SDKs have to offer by referring to each respective SDK:
 
-We provide samples of integrating with PingOne Advanced Identity Cloud and PingAM for the following platforms:
 - [JavaScript](./javascript/)
 
 - [iOS](./iOS/)
 
 - [Android](./android/)
 
-### Integrate with PingOne DaVinci:
-
-- Samples coming soon
-
 ## Documentation
 
-Detailed [documentation](https://docs.pingidentity.com/sdks/latest/sdks/index.html) is provided, and includes topics such as:
+Detailed [documentation](https://docs.pingidentity.com/sdks) is provided, and includes topics such as:
 
-- Introducing the SDK Features
-- Preparing your server for use with the SDKs
+- Tutorial walkthroughs for each server
+- Integrating functionality such as PingOne Protect, WebAuthn, and more
+- Code snippets
 - API Reference documentation
 
 ## Requirements
diff --git a/android/README.md b/android/README.md
@@ -1,15 +1,27 @@
 <p align="center">
   <a href="https://github.com/ForgeRock/sdk-sample-apps">
-    <img src="https://cdn.forgerock.com/logo/interim/Logo-PingIdentity-ForgeRock-Hor-FullColor.svg" alt="Logo">
+    <img src="https://www.pingidentity.com/content/dam/picr/nav/Ping-Logo-2.svg" alt="Ping Identity Logo">
   </a>
   <hr/>
 </p>
 
 ## Samples
 
-Ping provides these Android samples to help demonstrate SDK functionality/implementation. They are provided "as is" and are not official products of Ping and are not officially supported.
+_Ping provides these Android samples to help demonstrate SDK functionality/implementation. They are provided "as is" and are not official products of Ping and are not officially supported._
 
-### Integrate with PingOne Advanced Identity Cloud / PingAM:
+The Ping SDK for Android enables you to integrate your Android application with Ping services.
+
+There are two UI deployment options:
+- Embedded:
+  - With this option, each app has to have its own login User Interface (UI). 
+  - Users  authenticate natively to your application.
+- OIDC (Redirect) Login:
+  - Often referred to as centralized login, with this option you reuse a central UI (such as hosted pages for PingOne Advanced Identity Cloud or the Login Widget for PingOne/PingOne DaVinci) your own web application for login requests in multiple apps and sites. 
+  - User's are redirected via a browser to a central place for authentication.
+
+We provide samples that demonstrate both methods.
+
+### Integrate with Auth Journeys - PingOne Advanced Identity Cloud / PingAM:
 
 To try out the Ping Android SDK please look at one of our samples:
 
@@ -36,9 +48,33 @@ To try out the Ping Android SDK please look at one of our samples:
   (https://docs.pingidentity.com/sdks/latest/sdks/tutorials/android/index.html)
 
 
-### Integrate with PingOne:
+### Integrate with flows - PingOne DaVinci:
+
+- [**Kotlin DaVinci - `/kotlin-davinci`**](./kotlin-davinci/)
+  - An example Android project making use of the OOTB PingOne Sign on With Sessions flow in DaVinci environments and found in the marketplace.       Demonstrates use cases such as user authentication, registration, and account recovery.
+
+    (https://docs.pingidentity.com/sdks/latest/davinci/tutorials/android/index.html)
+
+### OIDC Login:
+
+- [**Kotlin Central Login OIDC - `/kotlin-central-login-oidc`**](./kotlin-central-login-oidc/)
+  - A sample app
+    that demonstrates the functionality
+    of using the Ping SDK for Android for OIDC (redirect) authentication.
+    Can be used with PingOne Advanced Identity Cloud,
+    PingOne, PingOne DaVinci (via a PingOne application),
+    PingAM, and PingFederate.
+    (https://docs.pingidentity.com/sdks/latest/oidc/index.html)
+
+
+## Documentation
+
+Detailed [documentation](https://docs.pingidentity.com/sdks) is provided, and includes topics such as:
 
-- Samples coming soon
+- Tutorial walkthroughs for each server
+- Integrating functionality such as PingOne Protect, WebAuthn, and more
+- Code snippets
+- API Reference documentation
 
 ## Requirements
 
diff --git a/android/java-authenticator/README.md b/android/java-authenticator/README.md
@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://github.com/ForgeRock/sdk-sample-apps">
-    <img src="https://cdn.forgerock.com/logo/interim/Logo-PingIdentity-ForgeRock-Hor-FullColor.svg" alt="Logo">
+    <img src="https://www.pingidentity.com/content/dam/picr/nav/Ping-Logo-2.svg" alt="Ping Identity Logo">
   </a>
   <hr/>
 </p>
diff --git a/android/java-quickstart/README.md b/android/java-quickstart/README.md
@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://github.com/ForgeRock/sdk-sample-apps">
-    <img src="https://cdn.forgerock.com/logo/interim/Logo-PingIdentity-ForgeRock-Hor-FullColor.svg" alt="Logo">
+    <img src="https://www.pingidentity.com/content/dam/picr/nav/Ping-Logo-2.svg" alt="Ping Identity Logo">
   </a>
   <hr/>
 </p>
diff --git a/android/java-ui-prototype/README.md b/android/java-ui-prototype/README.md
@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://github.com/ForgeRock/sdk-sample-apps">
-    <img src="https://cdn.forgerock.com/logo/interim/Logo-PingIdentity-ForgeRock-Hor-FullColor.svg" alt="Logo">
+    <img src="https://www.pingidentity.com/content/dam/picr/nav/Ping-Logo-2.svg" alt="Ping Identity Logo">
   </a>
   <hr/>
 </p>
diff --git a/android/kotlin-central-login-oidc/README.md b/android/kotlin-central-login-oidc/README.md
@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://github.com/ForgeRock/sdk-sample-apps">
-    <img src="https://cdn.forgerock.com/logo/interim/Logo-PingIdentity-ForgeRock-Hor-FullColor.svg" alt="Logo">
+    <img src="https://www.pingidentity.com/content/dam/picr/nav/Ping-Logo-2.svg" alt="Ping Identity Logo">
   </a>
   <hr/>
 </p>
diff --git a/android/kotlin-davinci/README.md b/android/kotlin-davinci/README.md
@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://github.com/ForgeRock/sdk-sample-apps">
-    <img src="https://cdn.forgerock.com/logo/interim/Logo-PingIdentity-ForgeRock-Hor-FullColor.svg" alt="Logo">
+    <img src="https://www.pingidentity.com/content/dam/picr/nav/Ping-Logo-2.svg" alt="Ping Identity Logo">
   </a>
   <hr/>
 </p>
diff --git a/android/kotlin-quickstart/README.md b/android/kotlin-quickstart/README.md
@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://github.com/ForgeRock/sdk-sample-apps">
-    <img src="https://cdn.forgerock.com/logo/interim/Logo-PingIdentity-ForgeRock-Hor-FullColor.svg" alt="Logo">
+    <img src="https://www.pingidentity.com/content/dam/picr/nav/Ping-Logo-2.svg" alt="Ping Identity Logo">
   </a>
   <hr/>
 </p>
diff --git a/android/kotlin-ui-prototype/README.md b/android/kotlin-ui-prototype/README.md
@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://github.com/ForgeRock/sdk-sample-apps">
-    <img src="https://cdn.forgerock.com/logo/interim/Logo-PingIdentity-ForgeRock-Hor-FullColor.svg" alt="Logo">
+    <img src="https://www.pingidentity.com/content/dam/picr/nav/Ping-Logo-2.svg" alt="Ping Identity Logo">
   </a>
   <hr/>
 </p>
diff --git a/iOS/README.md b/iOS/README.md
@@ -1,15 +1,27 @@
 <p align="center">
   <a href="https://github.com/ForgeRock/sdk-sample-apps">
-    <img src="https://cdn.forgerock.com/logo/interim/Logo-PingIdentity-ForgeRock-Hor-FullColor.svg" alt="Logo">
+    <img src="https://www.pingidentity.com/content/dam/picr/nav/Ping-Logo-2.svg" alt="Ping Identity Logo">
   </a>
   <hr/>
 </p>
 
 ## Samples
 
-Ping provides these iOS samples to help demonstrate SDK functionality/implementation. They are provided "as is" and are not official products of Ping and are not officially supported.
+_Ping provides these iOS samples to help demonstrate SDK functionality/implementation. They are provided "as is" and are not official products of Ping and are not officially supported._
 
-### Integrate with PingOne Advanced Identity Cloud / PingAM:
+The Ping SDK for iOS enables you to integrate your iOS application with Ping services.
+
+There are two UI deployment options:
+- Embedded:
+  - With this option, each app has to have its own login User Interface (UI).
+  - Users  authenticate natively to your application.
+- OIDC (Redirect) Login:
+  - Often referred to as centralized login, with this option you reuse a central UI (such as hosted pages for PingOne Advanced Identity Cloud or the Login Widget for PingOne/PingOne DaVinci) your own web application for login requests in multiple apps and sites.
+  - User's are redirected via a browser to a central place for authentication.
+
+We provide samples that demonstrate both methods.
+
+### Integrate with Auth Journeys - PingOne Advanced Identity Cloud / PingAM:
 
 To try out the Ping iOS SDK please look at one of our samples:
 
@@ -34,12 +46,34 @@ To try out the Ping iOS SDK please look at one of our samples:
   (https://docs.pingidentity.com/sdks/latest/sdks/tutorials/ios/index.html)
 
 
-### Integrate with PingOne:
+### Integrate with flows - PingOne DaVinci:
+
+-  [**DaVinci using SwiftUI - `/ios/swiftui-davinci`**](./swiftui-davinci/)
+
+    - An example iOS project written in Swift/SwiftUI making use of the SDK.
+      The sample supports the OOTB PingOne Sign on With Sessions flow in DaVinci environments and found in the marketplace. Demonstrates use cases such as user authentication, registration, and account recovery.
+    (https://docs.pingidentity.com/sdks/latest/davinci/tutorials/ios/index.html)
+
+   
+### OIDC Login:
+
+- [**OIDC (Redirect) Login using SwiftUI - `/ios/swiftui-oidc`**](./swiftui-oidc/)
+  - A sample app
+    that demonstrates the functionality
+    of using the Ping SDK for iOS for OIDC (redirect) authentication.
+    Can be used with PingOne Advanced Identity Cloud,
+    PingOne, PingOne DaVinci (via a PingOne application),
+    PingAM, and PingFederate.
+    (https://docs.pingidentity.com/sdks/latest/oidc/index.html)
+
+## Documentation
 
--  [**Davinci using SwiftUI - `/ios/swiftui-davinci`**](./swiftui-davinci/)
+Detailed [documentation](https://docs.pingidentity.com/sdks) is provided, and includes topics such as:
 
-    - An example iOS project written in Swift/SwiftUI making use of the SDK. The sample supports the OOTB DaVinci Login flow.
-    
+- Tutorial walkthroughs for each server
+- Integrating functionality such as PingOne Protect, WebAuthn, and more
+- Code snippets
+- API Reference documentation
 
 ## Requirements
 
diff --git a/iOS/swiftui-davinci/README.md b/iOS/swiftui-davinci/README.md
@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://github.com/ForgeRock/sdk-sample-apps">
-    <img src="https://cdn.forgerock.com/logo/interim/Logo-PingIdentity-ForgeRock-Hor-FullColor.svg" alt="Logo">
+    <img src="https://www.pingidentity.com/content/dam/picr/nav/Ping-Logo-2.svg" alt="Ping Identity Logo">
   </a>
   <hr/>
 </p>
diff --git a/iOS/swiftui-oidc/README.md b/iOS/swiftui-oidc/README.md
@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://github.com/ForgeRock/sdk-sample-apps">
-    <img src="https://cdn.forgerock.com/logo/interim/Logo-PingIdentity-ForgeRock-Hor-FullColor.svg" alt="Logo">
+    <img src="https://www.pingidentity.com/content/dam/picr/nav/Ping-Logo-2.svg" alt="Ping Identity Logo">
   </a>
   <hr/>
 </p>
diff --git a/iOS/uikit-passkeys/README.md b/iOS/uikit-passkeys/README.md
@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://github.com/ForgeRock/sdk-sample-apps">
-    <img src="https://cdn.forgerock.com/logo/interim/Logo-PingIdentity-ForgeRock-Hor-FullColor.svg" alt="Logo">
+    <img src="https://www.pingidentity.com/content/dam/picr/nav/Ping-Logo-2.svg" alt="Ping Identity Logo">
   </a>
   <hr/>
 </p>
diff --git a/javascript/README.md b/javascript/README.md
@@ -1,13 +1,26 @@
 <p align="center">
   <a href="https://github.com/ForgeRock/sdk-sample-apps">
-    <img src="https://cdn.forgerock.com/logo/interim/Logo-PingIdentity-ForgeRock-Hor-FullColor.svg" alt="Logo">
+    <img src="https://www.pingidentity.com/content/dam/picr/nav/Ping-Logo-2.svg" alt="Ping Identity Logo">
   </a>
   <hr/>
 </p>
 
 ## Samples
 
-Ping provides these samples to help demonstrate SDK functionality/implementation. They are provided "as is" and are not official products of Ping and are not officially supported.
+_Ping provides these samples to help demonstrate SDK functionality/implementation. They are provided "as is" and are not official products of Ping and are not officially supported._
+
+The Ping SDK for JavaScript enables you to integrate your SPA with our services.
+
+There are two UI deployment options:
+- Embedded:
+  - With this option, each app has to have its own login User Interface (UI).
+  - Users  authenticate natively to your application.
+- OIDC (Redirect) Login:
+  - Often referred to as centralized login, with this option you reuse a central UI (such as hosted pages for PingOne Advanced Identity Cloud or the Login Widget for PingOne/PingOne DaVinci) your own web application for login requests in multiple apps and sites.
+  - User's are redirected via a browser to a central place for authentication.
+
+We provide samples that demonstrate both methods.
+
 
 ### Integrate with PingOne Advanced Identity Cloud / PingAM:
 
@@ -27,22 +40,25 @@ To try out the Ping JavaScript SDK please look at one of our samples:
   - Todo application that involves authentication and authorization of a user to post Todos with the `@forgerock/javascript-sdk` in Angular.
     The main branch includes many flavors of callbacks, including WebAuthN, embedded login, and social login.
 
-### Integrate with PingOne:
+### Integrate with flows - PingOne DaVinci:
+
+- [**Embedded Login DaVinci - `embedded-login-davinci`**](./embedded-login-davinci/)
 
- - Coming soon
+  - This sample app uses the PingOne Sign on With Sessions OOTB in DaVinci environments and found in the marketplace.       Demonstrates use cases such as user authentication, registration, and account recovery.
 
-### Generic OIDC
+### OIDC Login:
 
 - [**Central login - `central-login-oidc`**](./central-login-oidc/README.md)
 
   - A barebones example of how to use the `@forgerock/javascript-sdk` in a vanilla html & javascript app with centralized login with AIC/AM or PingOne services(OIDC Login). Configure the server type on the `.env` file. 
 
 ## Documentation
 
-Documentation for the SDKs is provided on [ForgeRock Backstage](https://docs.pingidentity.com/sdks/latest/index.html), and includes topics such as:
+Detailed [documentation](https://docs.pingidentity.com/sdks) is provided, and includes topics such as:
 
-- Introducing the SDK Features
-- Preparing your server for use with the SDKs
+- Tutorial walkthroughs for each server
+- Integrating functionality such as PingOne Protect, WebAuthn, and more
+- Code snippets
 - API Reference documentation
 
 ## Requirements
diff --git a/javascript/central-login-oidc/README.md b/javascript/central-login-oidc/README.md
@@ -1,6 +1,7 @@
-# Central login OIDC
+# OIDC Login
 
-The SDK provides an option for using the Authorization Code Flow (with PKCE) with a centralized login application.
+The SDK provides an option for using the Authorization Code Flow
+(with PKCE) with a centralized application using OIDC Login. 
 
 For a non-authenticated user, use the `login: redirect` parameter of the `TokenManager` class to request OAuth/OIDC tokens. 
 
diff --git a/reactnative/README.md b/reactnative/README.md
@@ -1,13 +1,13 @@
 <p align="center">
   <a href="https://github.com/ForgeRock/sdk-sample-apps">
-    <img src="https://cdn.forgerock.com/logo/interim/Logo-PingIdentity-ForgeRock-Hor-FullColor.svg" alt="Ping Identity Logo">
+    <img src="https://www.pingidentity.com/content/dam/picr/nav/Ping-Logo-2.svg" alt="Ping Identity Logo">
   </a>
   <hr/>
 </p>
 
 # Ping SDKs Sample App Using React Native
 
-This repository contains React Native sample apps provided by **Ping Identity** to demonstrate SDK functionality and implementation. These samples are for demonstration purposes only, are provided **"as is"**, and are not official Ping products nor supported by Ping.
+_This repository contains React Native sample apps provided by **Ping Identity** to demonstrate SDK functionality and implementation. These samples are for demonstration purposes only, are provided **"as is"**, and are not official Ping products nor supported by Ping._
 
 The sample app uses a **bridging architecture** to integrate **Ping SDKs** with React Native. you can also modify the code to use  **bridgeless** architecture as well. The apps rely on the  [`../javascript/todo-api/`](../javascript/todo-api/) project for backend storage, specifically for a simple **To-Do** list example.
 
