Skip to content

Commit 01a70c1

Browse files
committed
docs: add experimental software disclaimer
Add prominent warning that this SDK is experimental and not for production use. Directs users to the ATProto SDK and scaffold app for production. Changes: - Add warning banner to root README.md - Add warning banner to sdk-core README.md - Add warning banner to sdk-react README.md - Add runtime console.warn on SDK instantiation
1 parent 877d12c commit 01a70c1

4 files changed

Lines changed: 25 additions & 0 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Hypercerts SDK
22

3+
> **⚠️ Experimental Software — Not for Production Use**
4+
>
5+
> This SDK is experimental and under active development. It should **not** be used in production environments. For
6+
> production use, please use the [ATProto SDK](https://github.com/bluesky-social/atproto/tree/main/packages) directly
7+
> and the [scaffold app](https://github.com/hypercerts-org/hypercerts-app) as a reference implementation.
8+
39
A monorepo containing SDK packages for the Hypercerts protocol on ATProto.
410

511
## Packages

packages/sdk-core/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# @hypercerts-org/sdk-core
22

3+
> **⚠️ Experimental Software — Not for Production Use**
4+
>
5+
> This SDK is experimental and under active development. It should **not** be used in production environments. For
6+
> production use, please use the [ATProto SDK](https://github.com/bluesky-social/atproto/tree/main/packages) directly
7+
> and the [scaffold app](https://github.com/hypercerts-org/hypercerts-app) as a reference implementation.
8+
39
Framework-agnostic ATProto SDK for Hypercerts. Create, manage, and collaborate on hypercerts using the AT Protocol.
410

511
```bash

packages/sdk-core/src/core/SDK.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,13 @@ export class ATProtoSDK {
175175
// Initialize OAuth client
176176
this.oauthClient = new OAuthClient(configWithDefaults);
177177

178+
// Experimental software warning
179+
console.warn(
180+
"[@hypercerts-org/sdk-core] ⚠️ This SDK is experimental and should not be used in production. " +
181+
"For production use, please use the ATProto SDK (https://github.com/bluesky-social/atproto) " +
182+
"and the scaffold app (https://github.com/hypercerts-org/hypercerts-app).",
183+
);
184+
178185
this.logger?.info("ATProto SDK initialized");
179186
}
180187

packages/sdk-react/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# @hypercerts-org/sdk-react
22

3+
> **⚠️ Experimental Software — Not for Production Use**
4+
>
5+
> This SDK is experimental and under active development. It should **not** be used in production environments. For
6+
> production use, please use the [ATProto SDK](https://github.com/bluesky-social/atproto/tree/main/packages) directly
7+
> and the [scaffold app](https://github.com/hypercerts-org/hypercerts-app) as a reference implementation.
8+
39
React hooks and components for the Hypercerts ATProto SDK.
410

511
```bash

0 commit comments

Comments
 (0)