Skip to content

Commit 5716363

Browse files
committed
Add notice about alfa version
1 parent 328ce87 commit 5716363

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,16 @@ Supported Catalystwan WAN Server Versions
1414
- 20.15
1515
- 20.16
1616

17+
1718
Important Notice: Version Incompatibility
1819
-----------------------------------------
1920

20-
Cisco Catalyst WAN SDK Version 2.0 Incompatibility with Legacy Versions
21-
We are excited to announce the release of Cisco Catalyst WAN SDK version 2.0.
22-
This new version introduces a range of enhancements and features designed
23-
to improve performance and usability. However, it is important to note that version 2.0
21+
We are excited to announce the release of Cisco Catalyst WAN SDK version 2.0.
22+
This new version introduces a range of enhancements and features designed
23+
to improve performance and usability. However, it is important to note that version 2.0
2424
is not compatible with any previous legacy versions of the SDK.
2525

26+
2627
Actions Recommended:
2728
Backup: Ensure you have backups of your current projects before attempting to upgrade.
2829
Review Documentation: Carefully review the updated documentation and release notes for guidance on migration and new features.
@@ -32,6 +33,15 @@ We appreciate your understanding and cooperation as we continue to enhance the C
3233

3334
Thank you for your continued support and feedback!
3435

36+
37+
Not recommend to use in production environments.
38+
------------------------------------------------
39+
Cisco Catalyst WAN SDK in its `pre-alpha` release phase. This marks a significant milestone
40+
in empowering developers to unlock the full capabilities of Cisco's networking solutions.
41+
Please note that, as a pre-alpha release, this version of the SDK is still in active development
42+
and testing. It is provided "as is," with limited support offered on a best-effort basis.
43+
44+
3545
Supported Python Versions
3646
-------------------------
3747

@@ -49,7 +59,7 @@ To install the SDK, run the following command:
4959
pip install catalystwan==2.0.0a0
5060
```
5161

52-
To manually install the necessary Python packages in editable mode, you can use the `pip install -e` command.
62+
To manually install the necessary Python packages in editable mode, you can use the `pip install -e` command.
5363

5464
```bash
5565
pip install -e ./packages/catalystwan-types \
@@ -80,7 +90,7 @@ with create_client(url=url, username=username, password=password) as client:
8090
print(result)
8191
```
8292

83-
If you need to preform more complex operations that require models, they can utilize an alias: `m`.
93+
If you need to preform more complex operations that require models, they can utilize an alias: `m`.
8494
```python
8595

8696
with create_client(...) as client:

0 commit comments

Comments
 (0)