docs: add features and output section in readme #107
Merged
Conversation
This file contains hidden or 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
aayushmau5
requested review from
vinitshahdeo,
onbit-uchenik,
magicmatatjahu,
derberg and
asyncapi-bot-eve
as code owners
|
@derberg Are we missing something in the README? Let me know, I'll add them as well. |
| @@ -90,6 +95,33 @@ const output = diff(firstDocument, secondDocument, { | |||
| }); | |||
| ``` | |||
|
|
|||
| ## Output | |||
There was a problem hiding this comment.
@aayushmau5 Not sure, maybe we can present the different possible values in a tabular form?
There was a problem hiding this comment.
@vinitshahdeo What do you mean by tabular form 🤔 ?
|
lgtm, just not sure what @vinitshahdeo meant about tabular view |
|
Kudos, SonarCloud Quality Gate passed!
|
|
🎉 This PR is included in version 0.4.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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