Skip to content

Add links table to README#37

Merged
ojongerius merged 1 commit intomainfrom
readme-links
Apr 4, 2026
Merged

Add links table to README#37
ojongerius merged 1 commit intomainfrom
readme-links

Conversation

@ojongerius
Copy link
Copy Markdown
Contributor

@ojongerius ojongerius commented Apr 4, 2026

Summary

  • Adds a quick-reference links table to the top of README.md (after badges, before "What is this?")
  • Includes: project site & docs, per-SDK API references, blog post, npm, and PyPI links
  • Package names verified from sdk/ts/package.json and sdk/py/pyproject.toml

Test plan

  • Verify table renders correctly on GitHub
  • Confirm all links resolve

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a quick-reference links table near the top of the repository README to make key project resources easier to discover.

Changes:

  • Inserted a links table (project site/docs, SDK API references, blog post, npm, PyPI) between the header/badges and the “What is this?” section.

| **Project site & docs** | [agentreceipts.ai](https://agentreceipts.ai) |
| **API reference** | [Go](https://agentreceipts.ai/sdk-go/api-reference/) · [TypeScript](https://agentreceipts.ai/sdk-ts/api-reference/) · [Python](https://agentreceipts.ai/sdk-py/api-reference/) |
| **Blog** | [Your AI Agent Just Sent an Email](https://jongerius.solutions/post/your-ai-agent-just-sent-an-email/) |
| **npm** | [@agnt-rcpt/sdk-ts](https://www.npmjs.com/package/@agnt-rcpt/sdk-ts) |
Copy link

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The npm package name linked here ("@agnt-rcpt/sdk-ts") conflicts with the TypeScript quick-start section below, which currently instructs npm install @agent-receipts/sdk-ts and imports from @agent-receipts/sdk-ts. Please align the README to a single published package name (link + install/import examples) so users don’t copy an incorrect command.

Copilot uses AI. Check for mistakes.

</div>

| | |
Copy link

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This table uses an empty header row (| | |), which reduces clarity and can be less accessible for screen readers that rely on column headers. Consider adding descriptive headers (e.g., "Resource" / "Link") or switching to a simple bullet list if headers aren’t desired.

Suggested change
| | |
| Resource | Link |

Copilot uses AI. Check for mistakes.
@ojongerius ojongerius merged commit f5a84d1 into main Apr 4, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants