Skip to content

Improve README #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Improve README #18

wants to merge 11 commits into from

Conversation

saif-at-scalekit
Copy link
Contributor

@saif-at-scalekit saif-at-scalekit commented Aug 1, 2024 •
edited
Loading

  • Center the Logo
  • The Elevator Pitch should be forward looking without over-promising.
  • Mimimum requirements to install SDK
  • Minimum requirements to use the SDK
  • A quickstart with a different label
  • Examples
  • Contribute ( start, write on dev.to, etc )
  • License

Saif Ali Shaik added 5 commits August 10, 2024 11:33
Update README: Enhance usage examples and adjust NPM downloads badge
5a31942 
- Change NPM Downloads badge to show last 18 months instead of monthly downloads
- Expand usage section with more detailed examples and explanations
- Add a collapsible section explaining the sequence of single sign-on
- Improve code samples for better clarity and completeness
- Minor formatting and wording improvements throughout the document
Update README with installation instructions and usage examples for S…
be9dd08 
…calekit SDK

- Improved installation section with instructions for npm, yarn, pnpm, and bun
- Enhanced usage section with more detailed code examples
- Added API reference section with key method descriptions
- Reorganized and streamlined the overall structure of the README
- Removed redundant example code and simplified explanations
Enhance README with license badge and improved formatting
2291a11 
- Add GitHub license badge to the header
- Update code block language for authorization URL example
- Refine Examples section with direct clone commands
- Add Contributing section with guidelines
- Improve overall formatting and emojis for better readability
Improve README.md section formatting
24c0a9c 
- Upgrade 'Examples' and 'Contributing' sections from H3 to H2 headers
- Enhance visual hierarchy and consistency of document structure
Improve parameter formatting in README.md
ba048b3 
- Replace level 5 headers (####) with bold text for parameter names
- Enhance readability of API documentation section
- Standardize formatting for 'redirectUri', 'options', 'code', and 'idpInitiatedLoginToken' parameters
@saif-at-scalekit saif-at-scalekit marked this pull request as ready for review August 12, 2024 03:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ravibits ravibits Awaiting requested review from ravibits

@hrishikesh-p hrishikesh-p Awaiting requested review from hrishikesh-p

1 more reviewer

@nkbhasker nkbhasker nkbhasker approved these changes

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@saif-at-scalekit @nkbhasker