Update README formatting and to provide clearer explanation of examples #812
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
Codecov Report
@@ Coverage Diff @@
## master #812 +/- ##
=======================================
Coverage 65.10% 65.10%
=======================================
Files 4 4
Lines 149 149
Branches 37 37
=======================================
Hits 97 97
Misses 29 29
Partials 23 23 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Closed
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.
Description
The README is a little unclear about how the sample code is supposed to work and it has some formatting issues. This correct both of those problems.
It still remains to remove all the information in this README that is also in the
node-samlREADME. We should be referring people to that README instead of duplicating that here.