✨ Allow user to specify path to custom README template #68
Conversation
Codecov Report
@@ Coverage Diff @@
## master #68 +/- ##
=====================================
Coverage 100% 100%
=====================================
Files 21 21
Lines 165 175 +10
Branches 19 20 +1
=====================================
+ Hits 165 175 +10
Continue to review full report at Codecov.
|
|
Hi @hgb123, Thanks for this PR, I'll review it ASAP ! |
|
Hi, @kefranabg I have made some changes with test cases after our discussion above and rebased to resolve conflicts. Please take a look. |
There was a problem hiding this comment.
@hgb123 thanks for your awesome work ! 💪
I just made some changes, I let the error be thrown if template path is not valid, it's better for error tracking. I also added you as a contributor in the README.
Could you check my commit and tell me if you're ok with the changes ?
There was a problem hiding this comment.
@kefranabg nice refactoring, thank you for working this out with me.
I have leave a comment, please have a look.
|
@kefranabg I have added an example for this in the latest commit. It seems that everything is okay now. |
README.md
Outdated
|
|
||
| ```sh | ||
| npx readme-md-generator -y | ||
| ``` | ||
|
|
||
| Use your custom template (`-p, --path`) (currently we support ejs template only, check our example [here](https://raw.githubusercontent.com/kefranabg/readme-md-generator/master/templates/default.md)): |
There was a problem hiding this comment.
Unfortunately, we can't update the documentation for now 😄
I'll update the documentation when I'll publish the new release (4.2.0) on npm.
If we update the doc in this PR this will be displayed for all users but they won't be able to use the -p option as the published version on npm is still the old one
There was a problem hiding this comment.
@yannbertrand Okay. I removed that commit.
Implementation for #56
But there is a small change in the issue's example, I made it:
instead of
Summary of the feature: allow user to specify his own path to the custom template. If the path is not invalid, it will still use the default template.