Skip to content

[4.x] Document token authentication in the README - #103

Open
Hackwar wants to merge 1 commit into
joomla-framework:4.x-devfrom
Hackwar:4.x-readme-token-auth
Open

Hackwar wants to merge 1 commit into
joomla-framework:4.x-devfrom
Hackwar:4.x-readme-token-auth

Conversation

@Hackwar

@Hackwar Hackwar commented Nov 12, 2026

Copy link
Copy Markdown
Contributor

Summary of Changes

Both README examples configured api.username and api.password — which GitHub removed for the API on github.com in November 2020 — and used plain http:// API URLs. gh.token was only mentioned in one sentence, and the second example called $github->issues->getList() without saying that it needs authentication.

The README now shows token authentication (gh.token) as the way to authenticate, the https://<host>/api/v3 form of api.url for GitHub Enterprise Server, notes that username/password only works on GitHub Enterprise Server, and explains why the getList() example needs a token.

Testing Instructions

Documentation only.

Documentation Changes Required

This is the documentation change. #66 adds docs/authentication.md with the full option list; the README now matches it (apart from the gh.token.scheme option, which #65 renames to gh.token_scheme).

🤖 Generated with Claude Code

Both README examples configured api.username and api.password, which no
longer work against github.com, and used http:// API URLs. gh.token was
mentioned in one sentence only. Show token authentication, the https
/api/v3 URL form for GitHub Enterprise Server, and say that password
authentication only works on GitHub Enterprise Server.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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