Improve README #18
Open
Improve README #18
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
saif-at-scalekit
commented
Aug 1, 2024
•
saif-at-scalekit
commented
- 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
nkbhasker
approved these changes
Aug 9, 2024
saif-at-scalekit
force-pushed
the
docs/improve-readme
branch
from
a3b587e to
7095deb
Compare
added 5 commits
August 10, 2024 11:33
- 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
…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
- 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
- Upgrade 'Examples' and 'Contributing' sections from H3 to H2 headers - Enhance visual hierarchy and consistency of document structure
- 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
Compliance information
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.