Skip to content

Add Developer SDKs and CLI section to main README#5

Open
pimfeltkamp wants to merge 1 commit intomainfrom
add-sdk-suite-to-readme
Open

Add Developer SDKs and CLI section to main README#5
pimfeltkamp wants to merge 1 commit intomainfrom
add-sdk-suite-to-readme

Conversation

@pimfeltkamp
Copy link
Copy Markdown

Summary

  • Add a new Developer SDKs and CLI section to the main README so the eight official SDKs (Node, Python, Go, Ruby, Rust, PHP, Dart, Swift) and the CLI are discoverable from the org's most-visible page.
  • Each row links to the registry page, install command, and GitHub repo.
  • Add a TOC entry for the new section.
  • Update the Repository Structure block to also list CONTRIBUTING.md (which already exists on main but wasn't mentioned).
  • Add a GitHub link to the Links section pointing at the org page.

Why

Anyone landing on cryptohopper-resources from search or from docs.cryptohopper.com should immediately see that there are official cross-language SDKs, with one-line install snippets for the language they care about. The existing API Access section described the API but didn't say "and here is how you call it" — this fills that gap.

Notes

Test plan

Surfaces the eight official SDKs and the CLI on the org's most-visible
public page. Each row links to the registry page, install command, and
GitHub repo. Also adds CONTRIBUTING.md to the repo structure listing
and a GitHub org link to the Links section.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@pimfeltkamp
Copy link
Copy Markdown
Author

Known issue surfaced post-PR

Iter-25 audit found that pub.dev/packages/cryptohopper returns 404 — the Dart SDK has never been uploaded to pub.dev (release workflow's publish step is commented out pending a one-time manual bootstrap). So the table's dart pub add cryptohopper claim is currently inaccurate.

Fix is in flight at cryptohopper/cryptohopper-dart-sdk#2, which adds a PUBLISHING.md checklist for the manual bootstrap. Until that bootstrap happens (dart pub publish from a workstation), the only working install method is a git dependency.

Two options for this PR:

  1. Land as-is and accept that the Dart row is forward-looking until the one-time manual publish lands. (The other 8 rows all work today.)
  2. Amend the Dart row to mark it as "coming soon" or to show the git-dependency form.

I'd lean (1) — once the bootstrap publish lands (a couple-minute task on Pim's machine) the row becomes accurate and there's no further README churn. Happy to amend if you'd rather have the README perfectly reflect the current registry state.

@pimfeltkamp
Copy link
Copy Markdown
Author

Cross-link to PR #3 comment

Iter-41 audit found a pre-existing public cryptohopper-ios-sdk (Swift / CocoaPods / iOS-only, since 2020, 4 stars) that overlaps with the Swift row in this PR's table.

The new cryptohopper-swift-sdk (cross-platform via SwiftPM) is positioned differently, so they can coexist — but the README should ideally flag the difference so iOS-only mobile developers don't get confused. I've left a longer comment on PR #3 with the full picture of pre-existing SDKs in the org and suggested follow-ups.

Also worth adding to this PR's table: Kotlin / Android via the existing cryptohopper-android-sdk — currently absent from the install matrix.

Same as PR #3: I deliberately didn't amend this PR to avoid forcing a re-review. Happy to follow up with a small PR after this lands if you'd like the Android row + Swift caveat added.

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.

1 participant