rahuldkjain
98 lines
4.3 KiB
Markdown
98 lines
4.3 KiB
Markdown
<p align="center">
|
|
<a href="https://rahuldkjain.github.io/gh-profile-readme-generator">
|
|
<img alt="Github Profile Readme Generator" src="./src/images/mdg.png" width="60" />
|
|
</a>
|
|
</p>
|
|
<h1 align="center">
|
|
Github Profile Readme Generator
|
|
</h1>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/rahuldkjain/github-profile-readme-generator/blob/master/LICENSE" target="blank">
|
|
<img src="https://img.shields.io/github/license/rahuldkjain/github-profile-readme-generator?style=flat-square" alt="github-profile-readme-generator licence" />
|
|
</a>
|
|
<a href="https://github.com/rahuldkjain/github-profile-readme-generator/fork" target="blank">
|
|
<img src="https://img.shields.io/github/forks/rahuldkjain/github-profile-readme-generator?style=flat-square" alt="github-profile-readme-generator forks"/>
|
|
</a>
|
|
<a href="https://github.com/rahuldkjain/github-profile-readme-generator/stargazers" target="blank">
|
|
<img src="https://img.shields.io/github/stars/rahuldkjain/github-profile-readme-generator?style=flat-square" alt="github-profile-readme-generator stars"/>
|
|
</a>
|
|
<a href="https://github.com/rahuldkjain/github-profile-readme-generator/issues" target="blank">
|
|
<img src="https://img.shields.io/github/issues/rahuldkjain/github-profile-readme-generator?style=flat-square" alt="github-profile-readme-generator issues"/>
|
|
</a>
|
|
<a href="https://github.com/rahuldkjain/github-profile-readme-generator/pulls" target="blank">
|
|
<img src="https://img.shields.io/github/issues-pr/rahuldkjain/github-profile-readme-generator?style=flat-square" alt="github-profile-readme-generator pull-requests"/>
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center"><img src="./src/images/github-profile-readme-generator.gif" alt="github-profile-readme-generator gif" /></p>
|
|
|
|
<p align="center">
|
|
<a href="https://rahuldkjain.github.io/gh-profile-readme-generator" target="blank">View Demo</a>
|
|
·
|
|
<a href="https://github.com/rahuldkjain/github-profile-readme-generator/issues/new/choose">Report Bug</a>
|
|
·
|
|
<a href="https://github.com/rahuldkjain/github-profile-readme-generator/issues/new/choose">Request Feature</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<i>Loved the tool? Please consider <a href="https://paypal.me/rahuldkjain">donating</a> 💸 to help it improve!</i>
|
|
</p>
|
|
|
|
#### Tired of editing Github Profile README with new features?
|
|
This tool provides an easy way to create github profile readme with latest addons like `visitors count`, `github stats` etc.
|
|
|
|
#### 🚀 Try it out: [Live demo](https://rahuldkjain.github.io/gh-profile-readme-generator)
|
|
|
|
## 🧐 Features
|
|
Just fill the details like `Name`, `Tagline`, `Dev Platforms Username`, `Current Work`, `Portfolio`, `Blog` etc. with a minimal UI.
|
|
|
|
Click on `Generate README` to get your README in `markdown`.
|
|
You can preview the README too.
|
|
|
|
You can add latest addons like `visitors count`, `shields`, `dev icons`, `github stats` etc to your README in just one click.
|
|
|
|
## Installation Steps
|
|
1. Clone the repository
|
|
```bash
|
|
git clone https://github.com/rahuldkjain/github-profile-readme-generator.git
|
|
```
|
|
2. Change the working directory
|
|
```bash
|
|
cd github-profile-readme-generator
|
|
```
|
|
3. Install dependencies
|
|
```bash
|
|
npm install
|
|
```
|
|
4. Run the app
|
|
```bash
|
|
npm start
|
|
```
|
|
🌟 You are all set!
|
|
|
|
|
|
## Special Thanks 🙇
|
|
- [Anurag Hazra](https://github.com/anuraghazra) for amazing [github-readme-stats](https://github.com/anuraghazra/github-readme-stats)
|
|
- [Anton Komarev](https://github.com/antonkomarev) for super cool [github-profile-views-counter](https://github.com/antonkomarev/github-profile-views-counter)
|
|
- [Gautam Krishna R](https://github.com/gautamkrishnar) for the awesome [blog post workflow](https://github.com/gautamkrishnar/blog-post-workflow)
|
|
- [Julien Monty](https://github.com/konpa) for super useful [devicon](https://github.com/konpa/devicon)
|
|
|
|
## Sponsors 🙇
|
|
- [Scott C Wilson](https://github.com/scottcwilson) donated the first ever grant to this tool. A big thanks to him.
|
|
- [Max Schmitt](https://github.com/mxschmitt) loved the tool and showed the support with his donation. Thanks a lot.
|
|
|
|
|
|
<p align="center">
|
|
<a href="https://www.paypal.me/rahuldkjain"><img src="https://ionicabizau.github.io/badges/paypal.svg" alt="sponsor github profile readme generator"/>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://ko-fi.com/A0A81XXSX"><img src="https://www.ko-fi.com/img/githubbutton_sm.svg" alt="sponsor github profile readme generator"/>
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
Developed with ❤️ in India 🇮🇳
|
|
</p>
|