Skip to content

README: fixes and OSS polish#124

Open
thisisnkc wants to merge 1 commit intozerodha:masterfrom
thisisnkc:docs/readme-revamp
Open

README: fixes and OSS polish#124
thisisnkc wants to merge 1 commit intozerodha:masterfrom
thisisnkc:docs/readme-revamp

Conversation

@thisisnkc
Copy link
Copy Markdown

The README had a few mistakes and was a bit rough around the edges for an OSS project. This cleans it up without changing the core structure.

Fixes:

  • Missing "client" in the subtitle
  • Event name reconnectingreconnect (what the code actually fires)
  • Copyright year 2024 → 2026
  • Removed request_access_token() (old v3 API), replaced with generateSession()

Improvements:

  • Added npm/license/node badges
  • Added Table of Contents
  • Rewrote "A typical web application" as a numbered auth flow as it is easier to follow
  • Added a Contributing section
  • Minor formatting and wording cleanup throughout

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