rahuldkjain
65 lines
2.8 KiB
Markdown
65 lines
2.8 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">
|
|
<img src="https://img.shields.io/github/license/rahuldkjain/github-profile-readme-generator?style=flat-square" alt="github-profile-readme-generator licence" />
|
|
<img src="https://img.shields.io/github/forks/rahuldkjain/github-profile-readme-generator?style=flat-square" alt="github-profile-readme-generator forks"/>
|
|
<img src="https://img.shields.io/github/stars/rahuldkjain/github-profile-readme-generator?style=flat-square" alt="github-profile-readme-generator stars"/>
|
|
<img src="https://img.shields.io/github/issues/rahuldkjain/github-profile-readme-generator?style=flat-square" alt="github-profile-readme-generator issues"/>
|
|
<img src="https://img.shields.io/github/issues-pr/rahuldkjain/github-profile-readme-generator?style=flat-square" alt="github-profile-readme-generator pull-requests"/>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<i>Loved the tool? Please consider <a href="https://paypal.me/rahuldkjain">donating</a> 💸 to help it improve!</i>
|
|
</p>
|
|
|
|
<p align="center"><img src="./src/images/github-profile-readme-generator.gif" alt="github-profile-readme-generator gif" /></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)
|
|
- [Julien Monty](https://github.com/konpa) for super useful [devicon](https://github.com/konpa/devicon)
|
|
|
|
[](https://ko-fi.com/A0A81XXSX)
|
|
|
|
Designed with 💫 by [Rahul](https://rahuldkjain.github.io)
|