📝 Included Sections

• Technology Badges
• Shields (Status Badges)
• Contributors
  • Commit Count
  • Social Profiles
• License
• Related Projects
• Custom Markdown Sections
• Development Setup

• Extendable Plugin API
• Global Configuration
• Overide per project configuration or autodetector suggestions
• Add additional social profiles for contributors tables
• Custom Licenses
• Codestyle Section
  • Autodetect
    • Prettier
    • Eslint
    • PHPCS
• Dependencies
  • Python
• CI / CD Integration
• Frontend Desktop Application
• VSCode Plugin

⚡️ Usage

One Time Use

npx ptkrdme

Install

npm install -g ptkrdme
cd ~/Projects/example
ptkrdme

🧑‍💻 Contributing

if you are interested in working on the project, a great place to start is the wiki

It contains documentation and explanation of all the code in the repo

🧑‍💼 Contributors

| Name | Email |Commits | Social | | -------- | -------------- | -------------- | -------------------- | | marley plant | [email protected] | | |

📎 LICENSE

A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.

This Repository Is Licensed Under MIT License

💻 TECHNOLOGIES

🗃️ Related Projects

• @clack/prompts

• ascii-text-generator

• font-style

• user-email-enrichment

• mustache

• simple-icons

• tiny-cli-editor

• yaml

• yargs