readgen

Tired of creating README? I got you covered.

✨ Demo

🛠 Installation

sudo npm install -g readgen-cli

⌨️ Usage

Usage: read-gen [OPTIONS]

Options:
  -f TEXT     Custom font
  -s INT      Font size
  -c          Cover only
  -h, --help  Show this message and exit

• To generate README.md, install.sh and cover image

~$ readgen

• To generate cover image alone

~$ readgen -c

🥼 Run tests

./gradlew test

✍️ Author

👤 theapache64

• Twitter: @theapache64
• Email: [email protected]

Feel free to ping me 😉

🤝 Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Open an issue first to discuss what you would like to change.
2. Fork the Project
3. Create your feature branch (git checkout -b feature/amazing-feature)
4. Commit your changes (git commit -m 'Add some amazing feature')
5. Push to the branch (git push origin feature/amazing-feature)
6. Open a pull request

Please make sure to update tests as appropriate.

❤ Show your support

Give a ⭐️ if this project helped you!

☑️ TODO

• [ ] Add more cover image styles with different fonts
• [ ] Support Android projects
• [ ] Support SpringBoot projects

📝 License

Copyright © 2022 - theapache64

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

This README was generated by readgen ❤