Skip to content

Commit 0b48b01

Browse files
authored
readme updates for 24.2.10 release (#540)
1 parent bb51a77 commit 0b48b01

File tree

1 file changed

+26
-27
lines changed

1 file changed

+26
-27
lines changed

README.md

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<p align="center"><img width=60% src="docs/media/ReactSDK-Logo.png">
22

3-
# React SDK - Release Announcement - v24.1.10
3+
# React SDK - Release Announcement - v24.2.10
44

5-
**SDK-R v24.1.10** is **only compatible with Pega Infinity '24.1** and is related to the [**release/24.1.10**](https://github.com/pegasystems/react-sdk/tree/release/24.1.10) branch of the React SDK repository.
5+
**SDK-R v24.2.10** is **only compatible with Pega Infinity '24.2** and is related to the [**release/24.2.10**](https://github.com/pegasystems/react-sdk/tree/release/24.2.10) branch of the React SDK repository.
66
<br>
77

88
**Note**: The main branch is the active development branch for future versions of React SDK.
99

10-
This release allows React SDK users to take advantage of the latest SDK enhancements and fixes. For more information, see [ **What's New in SDK-R 24.1.10**](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/react-sdk-updates.html).
10+
This release allows React SDK users to take advantage of the latest SDK enhancements and fixes. For more information, see [ **What's New in SDK-R 24.2.10**](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/react-sdk-updates.html).
1111
<br />
1212

1313
This
@@ -16,12 +16,10 @@ about all of the React SDK releases.
1616

1717
<hr>
1818

19-
20-
***IMPORTANT:*** Please follow the guidelines documented here if you are upgrading from a previous version of React SDK: [Upgrading the SDK](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/upgrading-sdk.html)
19+
**_IMPORTANT:_** Please follow the guidelines documented [here](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/upgrading-sdk.html) if you are upgrading from a previous version of React SDK: Upgrading the SDK
2120

2221
---
2322

24-
2523
# Overview
2624

2725
The **React SDK** combined with Pega's client orchestration APIs provides a guided iterative development workflow experience that accelerates integrating Pega’s Constellation DX API with an alternative (non-Pega) UI. Integrating an alternative design system is achieved using DX Components.
@@ -40,42 +38,44 @@ A summary of the latest updates to the **@pega/react-sdk-components** and
4038

4139
## Pega Infinity Server and Constellation-enabled Application
4240

43-
This version of the React SDK assumes that you have access to a Pega Infinity server (**24.1.0+**) running an application that is configured to run using the Constellation UI service.
41+
This version of the React SDK assumes that you have access to a Pega Infinity server (**24.2.0+**) running an application that is configured to run using the Constellation UI service.
4442

45-
The **MediaCo** sample application is already configured as a Constellation application and can be found in the React SDK download associated with this repo which is available at [https://community.pega.com/marketplace/components/react-sdk](https://community.pega.com/marketplace/components/react-sdk). The OAuth 2.0 Client Registration records associated with the **MediaCo** application are available in the same React SDK download. For more information about the MediaCo sample application, see [MediaCo sample application](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/mediaco-sample-application.html).
43+
The **MediaCo** sample application is already configured as a Constellation application and can be found in the React SDK download associated with this repo which is available [here](https://community.pega.com/marketplace/components/react-sdk). The OAuth 2.0 Client Registration records associated with the **MediaCo** application are available in the same React SDK download. For more information about the MediaCo sample application, see [MediaCo sample application](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/mediaco-sample-application.html).
4644

4745
The **React SDK** has been tested with:
48-
- node 18.12.1/18.13.0
49-
- npm 8.19.2/8.19.3 - **Note: Do not use _npm 9_**
50-
51-
Future updates to the SDK will support more recent LTS versions of node as Constellation supports them.
5246

53-
**Before** installing and running the SDK code, refer to [Downloading the Constellation SDK files](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/installing-constellation-sdks.html) for steps to prepare your Infinity server and node environment so you can proceed with the steps in the next section.
47+
- node 20.12.1
48+
- npm 10.5.0
5449

50+
Future updates to the SDK will support more recent LTS versions of node as Constellation supports them.
5551

52+
**Before** installing and running the SDK code, refer to [Downloading the Constellation SDK files](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/installing-constellation-sdks.html) for steps to prepare your Pega Infinity server and node environment so you can proceed with the steps in the next section.
5653

5754
<br>
5855

5956
---
57+
6058
# Installing and Running the Application
59+
6160
The following procedures provide an overview of installing Constellation SDKs and running the application. For more information, see [Installing and configuring Constellation SDKs](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/installing-configuring-constellation-sdks.html).
6261

6362
# Developing with the SDKs
63+
6464
You can find more details on how to integrate the latest React SDK into your development workflow and also instructions on the new using the new DX Component Builder for SDK features.
6565

6666
For more information, see [Development](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/development.html).
6767

6868
# Troubleshooting
69-
If you are facing any issues, please see [Troubleshooting Constellation SDKs](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/troubleshooting-constellation-sdks.html).
7069

70+
If you are facing any issues, please see [Troubleshooting Constellation SDKs](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/troubleshooting-constellation-sdks.html).
7171

7272
---
7373

74-
## License
74+
## License
7575

7676
This project is licensed under the terms of the **Apache 2** license.
7777

78-
>You can see the full license [here](LICENSE) or directly on [apache.org](https://www.apache.org/licenses/LICENSE-2.0).
78+
> You can see the full license [here](LICENSE) or directly on [apache.org](https://www.apache.org/licenses/LICENSE-2.0).
7979
8080
<br>
8181

@@ -89,18 +89,17 @@ Refer to our [guidelines for contributors](./docs/CONTRIBUTING.md) if you are in
8989

9090
<br>
9191

92-
9392
---
9493

9594
## Additional Resources
9695

97-
* [**KeyReleaseUpdates.md**](./node_modules/@pega/react-sdk-components/lib/doc/KeyReleaseUpdates.md): A summary of the latest updates to the **@pega/react-sdk-components** and
98-
**@pega/react-sdk-overrides** used by the React SDK can be found in the
99-
[react-sdk-components package's **KeyReleaseUpdates.md**](./node_modules/@pega/react-sdk-components/lib/doc/KeyReleaseUpdates.md).
100-
* To see if there are updates in the @pega/react-sdk-components and
101-
@pega/react-sdk-overrides packages published in a newer version than is
102-
currently installed, you can check the [package's main GitHub repo's **KeyReleaseUpdates.md**](https://github.com/pegasystems/react-sdk-components/blob/master/packages/react-sdk-components/doc/KeyReleaseUpdates.md).
103-
* [**Material UI**](https://v4.mui.com/)
104-
* [**Constellation SDKs Documentation**](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/constellation-sdks.html)
105-
* [**Troubleshooting Constellation SDKs**](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/troubleshooting-constellation-sdks.html)
106-
* [**MediaCo sample application**](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/mediaco-sample-application.html)
96+
- [**KeyReleaseUpdates.md**](./node_modules/@pega/react-sdk-components/lib/doc/KeyReleaseUpdates.md): A summary of the latest updates to the **@pega/react-sdk-components** and
97+
**@pega/react-sdk-overrides** used by the React SDK can be found in the
98+
[react-sdk-components package's **KeyReleaseUpdates.md**](./node_modules/@pega/react-sdk-components/lib/doc/KeyReleaseUpdates.md).
99+
- To see if there are updates in the @pega/react-sdk-components and
100+
@pega/react-sdk-overrides packages published in a newer version than is
101+
currently installed, see the [**KeyReleaseUpdates.md** file in the package's main GitHub repo](https://github.com/pegasystems/react-sdk-components/blob/master/packages/react-sdk-components/doc/KeyReleaseUpdates.md).
102+
- [**Material UI**](https://v5.mui.com/)
103+
- [**Constellation SDKs Documentation**](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/constellation-sdks.html)
104+
- [**Troubleshooting Constellation SDKs**](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/troubleshooting-constellation-sdks.html)
105+
- [**MediaCo sample application**](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/mediaco-sample-application.html)

0 commit comments

Comments
 (0)