fix(ts): adds deprecation notice to README

[stalniy]

📝 Description

Deprecate akash-api in favor of chain-sdk. Relates to akash-network/console#2083

🔧 Purpose of the Change

• New feature implementation
• Bug fix
• Documentation update
• Code refactoring
• Dependency upgrade
• Other: [specify]

📌 Related Issues

• Closes #ISSUE_NUMBER
• References #ISSUE_NUMBER

✅ Checklist

• I've updated relevant documentation
• Code follows Akash Network's style guide
• I've added/updated relevant unit tests
• Dependencies have been properly updated
• I agree and adhered to the Contribution Guidelines

📎 Notes for Reviewers

[Include any additional context, architectural decisions, or specific areas to focus on]

Summary by CodeRabbit

• Documentation
  • Added deprecation notice indicating the package is no longer actively maintained
  • Provided migration guidance directing users to chain-sdk

[coderabbitai]

Walkthrough

The TypeScript package README was updated with a deprecation notice indicating the package is no longer maintained, recommending users migrate to chain-sdk. Minor textual adjustments were also made to existing documentation.

Changes

Cohort / File(s)	Summary
Documentation Update ts/README.md	Added deprecation notice recommending migration to chain-sdk; minor text adjustments to TypeScript version notes

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Rationale: Documentation-only changes with no logic, no code modifications, and no exported/public declaration changes.

Poem

🐰 A notice hops into the README so clear,
"This path's retired, new chains appear!"
From old to chain-sdk, migration calls,
The repo rests, yet knowledge stands tall. 📚

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The pull request description follows the template structure and includes the essential components: a description explaining the deprecation, a correctly marked Purpose of Change checkbox (Documentation update), and relevant checklist items. However, the description has notable gaps compared to the template requirements. The Related Issues section contains unfilled placeholders ("Closes #ISSUE_NUMBER", "References #ISSUE_NUMBER") rather than concrete issue references, the description itself is only one sentence when the template requests 2-3 sentences, and the Notes for Reviewers section remains as placeholder text without substantive content.
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title "fix(ts): adds deprecation notice to README" is clear and specific about the main change, directly aligning with the raw summary which confirms a deprecation notice was added to the README. The title effectively communicates the primary alteration to the codebase, and a developer scanning history would immediately understand that a deprecation notice was introduced. While the commit type "fix" could be debatable for a documentation-only change (the PR itself classifies this as a documentation update), the descriptive portion of the title accurately reflects the actual change.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/deprecation-notice

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between baf66be and e65e506.

📒 Files selected for processing (1)

• ts/README.md (3 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

• GitHub Check: go
• GitHub Check: test
• GitHub Check: coverage

🔇 Additional comments (3)

ts/README.md (3)

7-8: Clear and well-positioned deprecation notice.

The deprecation notice is actionable and prominently placed. It clearly communicates the package's status and directs users to the migration path with a direct link to chain-sdk.

Optional enhancement: Consider adding a deprecation date (e.g., "Deprecated as of October 2025") or migration timeline to set clearer expectations for users still depending on this package.

---

30-30: Textual clarification is appropriate.

The minor adjustment to the TypeScript 4.5+ note improves readability without altering the substance of the guidance.

---

62-62: License section updated consistently.

The wording adjustment maintains accuracy and clarity regarding the Apache 2.0 license.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

🎉 This PR is included in version 1.4.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀