Skip to content

Commit 592cc81

Browse files
authored
Merge pull request #142 from hypercerts-org/readme-maintenance-notice
[HYPER-260] add maintenance notice to README and AGENTS.md
2 parents 6a34e81 + eaf338d commit 592cc81

4 files changed

Lines changed: 42 additions & 12 deletions

File tree

AGENTS.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# AGENTS.MD - AI Agent Instructions for Hypercerts SDK
22

3+
> **⚠️ Not Currently Maintained — Do Not Use**
4+
>
5+
> This SDK is **currently unmaintained** while the Hypercerts core development team focuses on higher-priority matters,
6+
> and **should not be used**. It is currently out of sync with the
7+
> [`@hypercerts-org/lexicon`](https://www.npmjs.com/package/@hypercerts-org/lexicon) package and is likely to break when
8+
> creating or updating Hypercerts records on ATProto. We'll reassess it over the coming months, informed by developer
9+
> feedback and developments in AI.
10+
>
11+
> In the meantime, we recommend using the
12+
> [`@hypercerts-org/lexicon`](https://www.npmjs.com/package/@hypercerts-org/lexicon) package directly, along with the
13+
> official [AT Protocol SDK](https://github.com/bluesky-social/atproto) and related packages.
14+
315
This document provides instructions for AI agents working in the Hypercerts SDK repository.
416

517
## Project Overview

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
# Hypercerts SDK
22

3-
> **⚠️ Experimental Software — Not for Production Use**
3+
> **⚠️ Not Currently Maintained — Do Not Use**
44
>
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.
5+
> This SDK is **currently unmaintained** while the Hypercerts core development team focuses on higher-priority matters,
6+
> and **should not be used**. It is currently out of sync with the
7+
> [`@hypercerts-org/lexicon`](https://www.npmjs.com/package/@hypercerts-org/lexicon) package and is likely to break when
8+
> creating or updating Hypercerts records on ATProto. We'll reassess it over the coming months, informed by developer
9+
> feedback and developments in AI.
10+
>
11+
> In the meantime, we recommend using the
12+
> [`@hypercerts-org/lexicon`](https://www.npmjs.com/package/@hypercerts-org/lexicon) package directly, along with the
13+
> official [AT Protocol SDK](https://github.com/bluesky-social/atproto) and related packages.
814
915
A monorepo containing SDK packages for the Hypercerts protocol on ATProto.
1016

packages/sdk-core/README.md

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

3-
> **⚠️ Experimental Software — Not for Production Use**
3+
> **⚠️ Not Currently Maintained — Do Not Use**
44
>
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.
5+
> This SDK is **currently unmaintained** while the Hypercerts core development team focuses on higher-priority matters,
6+
> and **should not be used**. It is currently out of sync with the
7+
> [`@hypercerts-org/lexicon`](https://www.npmjs.com/package/@hypercerts-org/lexicon) package and is likely to break when
8+
> creating or updating Hypercerts records on ATProto. We'll reassess it over the coming months, informed by developer
9+
> feedback and developments in AI.
10+
>
11+
> In the meantime, we recommend using the
12+
> [`@hypercerts-org/lexicon`](https://www.npmjs.com/package/@hypercerts-org/lexicon) package directly, along with the
13+
> official [AT Protocol SDK](https://github.com/bluesky-social/atproto) and related packages.
814
915
Framework-agnostic ATProto SDK for Hypercerts. Create, manage, and collaborate on hypercerts using the AT Protocol.
1016

packages/sdk-react/README.md

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

3-
> **⚠️ Experimental Software — Not for Production Use**
3+
> **⚠️ Not Currently Maintained — Do Not Use**
44
>
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.
5+
> This SDK is **currently unmaintained** while the Hypercerts core development team focuses on higher-priority matters,
6+
> and **should not be used**. It is currently out of sync with the
7+
> [`@hypercerts-org/lexicon`](https://www.npmjs.com/package/@hypercerts-org/lexicon) package and is likely to break when
8+
> creating or updating Hypercerts records on ATProto. We'll reassess it over the coming months, informed by developer
9+
> feedback and developments in AI.
10+
>
11+
> In the meantime, we recommend using the
12+
> [`@hypercerts-org/lexicon`](https://www.npmjs.com/package/@hypercerts-org/lexicon) package directly, along with the
13+
> official [AT Protocol SDK](https://github.com/bluesky-social/atproto) and related packages.
814
915
React hooks and components for the Hypercerts ATProto SDK.
1016

0 commit comments

Comments
 (0)