Skip to content

docs: add Authentication section to README - #2708

Merged
musa-cf merged 1 commit into
nextfrom
docs/add-authentication-section
Apr 30, 2026
Merged

docs: add Authentication section to README#2708
musa-cf merged 1 commit into
nextfrom
docs/add-authentication-section

Conversation

@musa-cf

@musa-cf musa-cf commented Apr 30, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add a new Authentication section to the README between Installation and Usage
  • Document the two primary auth methods: API Token (recommended) and API Key + Email
  • Include code examples showing both explicit and environment-variable-based configuration
  • Add a summary table mapping constructor parameters to env vars and HTTP headers

Fixes #2678

Document the supported authentication methods (API Token, API Key +
Email) with code examples, environment variable mappings, and a summary
table.
@musa-cf
musa-cf merged commit e4b3835 into next Apr 30, 2026
9 checks passed
@musa-cf
musa-cf deleted the docs/add-authentication-section branch April 30, 2026 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant