Skip to content

Commit 0070556

Browse files
committed
docs: add maintenance notice to README and AGENTS.md
1 parent 6a34e81 commit 0070556

2 files changed

Lines changed: 20 additions & 4 deletions

File tree

AGENTS.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
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://github.com/hypercerts-org/hypercerts-lexicon) package and is likely to break when
8+
> creating or updating Hypercerts records on ATProto. We plan to resume work on it in the next few months.
9+
>
10+
> In the meantime, we recommend using the
11+
> [`@hypercerts-org/lexicon`](https://github.com/hypercerts-org/hypercerts-lexicon) npm package directly, along with the
12+
> official [AT Protocol SDK](https://github.com/bluesky-social/atproto) and related packages.
13+
314
This document provides instructions for AI agents working in the Hypercerts SDK repository.
415

516
## Project Overview

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
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://github.com/hypercerts-org/hypercerts-lexicon) package and is likely to break when
8+
> creating or updating Hypercerts records on ATProto. We plan to resume work on it in the next few months.
9+
>
10+
> In the meantime, we recommend using the
11+
> [`@hypercerts-org/lexicon`](https://github.com/hypercerts-org/hypercerts-lexicon) npm package directly, along with the
12+
> official [AT Protocol SDK](https://github.com/bluesky-social/atproto) and related packages.
813
914
A monorepo containing SDK packages for the Hypercerts protocol on ATProto.
1015

0 commit comments

Comments
 (0)