Skip to content

[HYPER-260] add maintenance notice to README and AGENTS.md #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aspiers wants to merge 1 commit into
base: develop
Choose a base branch
from
+38 −12
Open

[HYPER-260] add maintenance notice to README and AGENTS.md #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# AGENTS.MD - AI Agent Instructions for Hypercerts SDK

> **⚠️ Not Currently Maintained — Do Not Use**
>
> This SDK is **currently unmaintained** while the Hypercerts core development team focuses on higher-priority matters,
> and **should not be used**. It is currently out of sync with the
> [`@hypercerts-org/lexicon`](https://www.npmjs.com/package/@hypercerts-org/lexicon) package and is likely to break when
> creating or updating Hypercerts records on ATProto. We plan to resume work on it in the next few months.
>
> In the meantime, we recommend using the
> [`@hypercerts-org/lexicon`](https://www.npmjs.com/package/@hypercerts-org/lexicon) package directly, along with the
> official [AT Protocol SDK](https://github.com/bluesky-social/atproto) and related packages.

This document provides instructions for AI agents working in the Hypercerts SDK repository.

## Project Overview
Expand Down
13 changes: 9 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
# Hypercerts SDK

> **⚠️ Experimental Software — Not for Production Use**
> **⚠️ Not Currently Maintained — Do Not Use**
>
> This SDK is experimental and under active development. It should **not** be used in production environments. For
> production use, please use the [ATProto SDK](https://github.com/bluesky-social/atproto/tree/main/packages) directly
> and the [scaffold app](https://github.com/hypercerts-org/hypercerts-app) as a reference implementation.
> This SDK is **currently unmaintained** while the Hypercerts core development team focuses on higher-priority matters,
> and **should not be used**. It is currently out of sync with the
> [`@hypercerts-org/lexicon`](https://www.npmjs.com/package/@hypercerts-org/lexicon) package and is likely to break when
> creating or updating Hypercerts records on ATProto. We plan to resume work on it in the next few months.
>
> In the meantime, we recommend using the
> [`@hypercerts-org/lexicon`](https://www.npmjs.com/package/@hypercerts-org/lexicon) package directly, along with the
> official [AT Protocol SDK](https://github.com/bluesky-social/atproto) and related packages.

A monorepo containing SDK packages for the Hypercerts protocol on ATProto.

Expand Down
13 changes: 9 additions & 4 deletions packages/sdk-core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
# @hypercerts-org/sdk-core

> **⚠️ Experimental Software — Not for Production Use**
> **⚠️ Not Currently Maintained — Do Not Use**
>
> This SDK is experimental and under active development. It should **not** be used in production environments. For
> production use, please use the [ATProto SDK](https://github.com/bluesky-social/atproto/tree/main/packages) directly
> and the [scaffold app](https://github.com/hypercerts-org/hypercerts-app) as a reference implementation.
> This SDK is **currently unmaintained** while the Hypercerts core development team focuses on higher-priority matters,
> and **should not be used**. It is currently out of sync with the
> [`@hypercerts-org/lexicon`](https://www.npmjs.com/package/@hypercerts-org/lexicon) package and is likely to break when
> creating or updating Hypercerts records on ATProto. We plan to resume work on it in the next few months.
>
> In the meantime, we recommend using the
> [`@hypercerts-org/lexicon`](https://www.npmjs.com/package/@hypercerts-org/lexicon) package directly, along with the
> official [AT Protocol SDK](https://github.com/bluesky-social/atproto) and related packages.

Framework-agnostic ATProto SDK for Hypercerts. Create, manage, and collaborate on hypercerts using the AT Protocol.

Expand Down
13 changes: 9 additions & 4 deletions packages/sdk-react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
# @hypercerts-org/sdk-react

> **⚠️ Experimental Software — Not for Production Use**
> **⚠️ Not Currently Maintained — Do Not Use**
>
> This SDK is experimental and under active development. It should **not** be used in production environments. For
> production use, please use the [ATProto SDK](https://github.com/bluesky-social/atproto/tree/main/packages) directly
> and the [scaffold app](https://github.com/hypercerts-org/hypercerts-app) as a reference implementation.
> This SDK is **currently unmaintained** while the Hypercerts core development team focuses on higher-priority matters,
> and **should not be used**. It is currently out of sync with the
> [`@hypercerts-org/lexicon`](https://www.npmjs.com/package/@hypercerts-org/lexicon) package and is likely to break when
> creating or updating Hypercerts records on ATProto. We plan to resume work on it in the next few months.
>
> In the meantime, we recommend using the
> [`@hypercerts-org/lexicon`](https://www.npmjs.com/package/@hypercerts-org/lexicon) package directly, along with the
> official [AT Protocol SDK](https://github.com/bluesky-social/atproto) and related packages.

React hooks and components for the Hypercerts ATProto SDK.

Expand Down
Loading