Skip to content

Commit b467470

Browse files
authored
SDKS-4619: Add Support and Disclaimer sections to README.md (#173)
Signed-off-by: Andy Witrisna <witrisna@gmail.com>
1 parent 4e2f953 commit b467470

20 files changed

Lines changed: 104 additions & 11 deletions

File tree

File renamed without changes.

README.md

Lines changed: 61 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,26 @@
33

44
[![Ping Identity](https://www.pingidentity.com/content/dam/picr/nav/Ping-Logo-2.svg)](https://github.com/ForgeRock/ping-android-sdk)
55

6-
The Ping SDK for Android is designed for creating mobile native Apps that seamlessly integrate with the PingOne platform.
7-
It offers a range of APIs for user authentication, user device management, and accessing resources secured by PingOne.
8-
This SDK is support Browser, iOS and Android platforms.
6+
The Ping SDK for Android is designed for creating mobile native Apps that seamlessly integrate with
7+
the PingOne platform.
8+
It offers a range of APIs for user authentication, user device management, and accessing resources
9+
secured by PingOne.
910

10-
Please visit our [ documentation ](https://docs.pingidentity.com/sdks/latest/sdks/index.html) site for more information.
11+
# Documentation
12+
13+
- **Quick Starts** - Find specific setup instructions in the quick start guide for each SDK module.
14+
Begin with
15+
the [DaVinci](https://docs.pingidentity.com/sdks/latest/davinci/tutorials/android/index.html)
16+
or [Journey](https://docs.pingidentity.com/sdks/latest/sdks/tutorials/android-quickstart/index.html)
17+
guide, based on your chosen orchestration platform.
18+
- **Sample Apps** - Visit our [sample apps](https://github.com/ForgeRock/sdk-sample-apps) repository
19+
on GitHub for examples showcasing various use cases.
20+
- **Official Docs** - Refer to our
21+
main [documentation site](https://docs.pingidentity.com/sdks/latest/sdks/index.html) for
22+
comprehensive information on the SDKs.
1123

1224
# Modules
25+
1326
ping
1427
├── foundation # Foundation module
1528
│ ├── android # Android common utilities
@@ -46,6 +59,49 @@ Please visit our [ documentation ](https://docs.pingidentity.com/sdks/latest/sdk
4659
└── samples # Sample applications
4760
└── pingsampleapp # Combined Ping sample app
4861

62+
# Support
63+
64+
If you encounter any issues, be sure to check our *
65+
*[Troubleshooting](https://docs.pingidentity.com/sdks/latest/sdks/troubleshooting.html)** pages.
66+
67+
Support tickets can be raised whenever you need our assistance; here are some examples of when it is
68+
appropriate to open a ticket (but not limited to):
69+
70+
* Suspected bugs or problems with Ping Identity software.
71+
* Requests for assistance - please look at the **[Documentation](https://docs.pingidentity.com/sdks)
72+
** and **[Knowledge Base](https://support.pingidentity.com/s/knowledge-base)** first.
73+
74+
You can raise a ticket using the *
75+
*[Ping Identity Support Portal](https://support.pingidentity.com/s/)** that provides one stop access
76+
to support services.
77+
78+
The support portal shows all currently open support tickets and allows you to raise a new one by
79+
clicking **New Ticket**.
80+
81+
# Contributing
82+
83+
If you would like to contribute to this project, please see
84+
the [contributions guide](./CONTRIBUTION.md).
85+
86+
# Disclaimer
87+
88+
> **This code is provided by Ping Identity Corporation ("Ping") on an "as is" basis, without
89+
warranty of any kind, to the fullest extent permitted by law.
90+
> Ping Identity Corporation does not represent or warrant or make any guarantee regarding the use of
91+
this code or the accuracy, timeliness or completeness of any data or information relating to this
92+
code, and Ping Identity Corporation hereby disclaims all warranties whether express, or implied or
93+
statutory, including without limitation the implied warranties of merchantability, fitness for a
94+
particular purpose, and any warranty of non-infringement.
95+
> Ping Identity Corporation shall not have any liability arising out of or related to any use,
96+
implementation or configuration of this code, including but not limited to use for any commercial
97+
purpose.
98+
> Any action or suit relating to the use of the code may be brought only in the courts of a
99+
jurisdiction wherein Ping Identity Corporation resides or in which Ping Identity Corporation
100+
conducts its primary business, and under the laws of that jurisdiction excluding its conflict-of-law
101+
provisions.**
102+
49103
# License
50104

51-
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details
105+
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details
106+
107+
© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved

davinci/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -363,4 +363,6 @@ user?.let {
363363
it.userinfo()
364364
it.logout()
365365
}
366-
```
366+
```
367+
368+
© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved

external-idp/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -419,4 +419,6 @@ By following these steps and including the native SDK dependencies, your applica
419419
more streamlined and
420420
user-friendly authentication experience when users choose to log in with Google or Facebook. The
421421
Ping External IDP
422-
library intelligently handles the integration with these native SDKs when they are present.
422+
library intelligently handles the integration with these native SDKs when they are present.
423+
424+
© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved

foundation/browser/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,3 +150,5 @@ customization allows you to override this behavior for specific use cases or bro
150150
| Redirect Handling | Manual, error-prone | Automatic via intent filters | Automatic via intent filters |
151151
| App Store Policy | May be restricted for auth flows | Fully compliant | Fully compliant |
152152
| Recommended For | Embedded content, not auth | Secure authentication/authorization | Secure authentication/authorization (preferred) |
153+
154+
© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved

foundation/device/device-client/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -655,3 +655,5 @@ This software may be modified and distributed under the terms of the MIT license
655655

656656
Copyright (c) 2025 Ping Identity Corporation. All rights reserved.
657657

658+
659+
© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved

foundation/device/device-id/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,4 +120,6 @@ val customId = CustomDeviceIdentifier.id
120120
persistence and security properties.
121121
- **Handle gracefully**: Be prepared to handle cases where the device identifier changes.
122122
- **Combine with other factors**: For authentication purposes, combine device identifiers with other
123-
factors like user credentials.
123+
factors like user credentials.
124+
125+
© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved

foundation/device/device-profile/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -577,3 +577,5 @@ interface AndroidBuildProvider {
577577
Provides testable access to Android Build properties.
578578

579579
---
580+
581+
© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved

foundation/device/device-root/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -248,3 +248,5 @@ suspend fun reportDeviceStatus() {
248248
}
249249
```
250250

251+
252+
© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved

foundation/migration/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -347,3 +347,5 @@ step("Access system resources") {
347347
6. **Test thoroughly**: Ensure migration steps work correctly in isolation and as part of the full migration
348348

349349
---
350+
351+
© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved

0 commit comments

Comments
 (0)