Apprag

Apprag - A Professional Project Readme Auto-Generator

• ⚡ Instantly generate README for your project
• ⚙️ Easily configure and customize Readme templates
• 🦾 Automating your task to write beautiful Readme
• 📦 Utilizing Nodejs package.json for project information

⭐ Public Url

https://npmjs.com/package/apprag

📚 Tech Stack

• NodeJs
• HandlebarJs
• Typescript
• Npm

📸 Screenshots

N.A

📜 Scripts

test : $ ts-node src/test.ts
build : $ rm -rf dist && tsc
build:win : $ rmdir /s dist && tsc
publish : $ npm publish --access=public

🔑 Keywords

readme,readme.md,auto-generator

👾 Submit issues at

https://github.com/m3yevn/apprag/issues

©️ License

MIT License

Copyright (c) 2020 Kevin Moe Myint Myat

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.

Dependencies

• axios : $ ^0.21.1
• handlebars : $ ^4.7.6

Dev Dependencies

• @types/node : $ ^14.0.13
• @typescript-eslint/eslint-plugin : $ ^3.2.0
• @typescript-eslint/parser : $ ^3.2.0
• eslint : $ ^7.2.0
• eslint-config-prettier : $ ^6.11.0
• husky : $ ^4.2.5
• lint-staged : $ ^10.2.9
• prettier : $ ^2.0.5
• ts-node : $ ^8.10.2
• typescript : $ ^3.9.5

Documentations

This project does not have documentations