Add alpha software warning to README #18
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a prominent alpha software warning to the top of the README to clearly communicate that this TypeScript SDK is currently in alpha and not stable.
Changes
Motivation
Since this is an alpha version of the TypeScript SDK, it's important to set proper expectations for users about the stability and maturity of the software. This warning helps prevent users from using it in production environments where stability is critical.
Testing
Type of Change
Checklist
@rbren can click here to continue refining the PR