Version 1.0.0
This is a markdown readme generator written in NodeJS.
To install this program, you have a couple options.
- Install program using
npm install readme-gen-jib - Download the repo and use node to run the index.js file
- Install the program following the instructions above.
- Run the program using
node index.jsfrom the installation directory. - Input all required information.
- Find the generated file in the output folder within the installation directory.
Copyright 2020 Evan Boswood
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
To contribute to this project, please contact me here.
Test using the included jest files in the test directory. (You will need jest installed)
If you have any questions or want to say hi, you can contact me at evan@boswood.net