Add additional example usage to readme #1
Merged
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
|
@sprusr YESSSSS thank you SO SO much for this. This was my first node package I ever published, and it clearly had a spotty README to boot. You wrote the perfect example; this module is so barebones that you need a bunch of other weird stuff to get an end to end "file in -> file out" solution. Merging and publising! ✨ thanks again, and I am glad you found this package to be useful! |
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.
I initially found it quite difficult to understand how to use this module in a project of my own. I think adding this further practical example could help people more easily get up and running with it.
As a side note, thanks so much for creating this! I found it immensely useful in a recent project, and probably wouldn't have been bothered to implement it myself!!