Skip to content

Document current client setup and return destinations - #25

Merged
g105b merged 1 commit into
masterfrom
21-readme
Oct 30, 2026
Merged

g105b merged 1 commit into
masterfrom
21-readme

Conversation

@g105b

@g105b g105b commented Oct 30, 2026

Copy link
Copy Markdown
Member

The README should show a complete setup using the current client API. Document PHP/Sodium requirements, loading the autoloader before starting a session, server-side client-key configuration, getAuthUser(), HTML escaping and the authentication callback. Explain login destination validation and logout destination precedence, link to the wiki, and use the configured Composer check commands.

Closes #21.

Validation: all wiki links resolve and all 25 PHP examples across the README and wiki pass syntax checks. This changes documentation only; GitHub CI runs the existing PHP 8.4/8.5 suite before merge. The sibling wiki updates are committed and pushed separately.

@g105b
g105b merged commit 7ff32a6 into master Oct 30, 2026
24 checks passed
@g105b
g105b deleted the 21-readme branch October 30, 2026 20:05
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.

Update README examples for the current user API, session setup and test commands

1 participant