View Demo ยท Report Bug ยท Request Feature
Loved the tool? Please consider donating ๐ธ to help it improve!
#### Tired of editing GitHub Profile README with new features? This tool provides an easy way to create a GitHub profile readme with the latest add-ons such as `visitors count`, `github stats`, etc. ## ๐ Demo Try the tool: [GitHub Profile README Generator](https://rahuldkjain.github.io/gh-profile-readme-generator) ## ๐ง Features Just fill in the details such as `Name`, `Tagline`, `Dev Platforms Username`, `Current Work`, `Portfolio`, `Blog`, etc. with a minimal UI. - **Uniform Dev Icons** - **Uniform Social Icons** - **Visitors Counter Badge** - **GitHub Profile Stats Card** - **GitHub Top Skills** - **GitHub Streak Stats** - **Dynamic Dev(.)to Blogs** (GitHub Action) - **Dynamic Medium Blogs** (GitHub Action) - **Dynamic Personal Blogs from RSS Feed** (GitHub Action) - **Wakatime Stats** [contribute](https://github.com/rahuldkjain/github-profile-readme-generator/issues/115) - **Buy Me A Coffee button** Click on `Generate README` to get your README in `markdown`. You can preview the README too. ## ๐ ๏ธ 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! ## ๐ฐ Contributing Please contribute using [GitHub Flow](https://guides.github.com/introduction/flow). Create a branch, add commits, and [open a pull request](https://github.com/rahuldkjain/github-profile-readme-generator/compare). Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us. ## ๐ป Built with - [Gatsby](https://www.gatsbyjs.com/) - [Tailwind CSS](https://tailwindcss.com/): for styling - [GSAP](https://greensock.com/gsap/): for small SVG Animations ## ๐ 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) - [Jonah Lawrence](https://github.com/DenverCoder1) for the incredible [github-readme-streak-stats](https://github.com/DenverCoder1/github-readme-streak-stats) - [Julien Monty](https://github.com/konpa) for super useful [devicon](https://github.com/konpa/devicon) - [Eliot Sanford](https://github.com/techieeliot) for adding hashnode as a blog input ## ๐ 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 support with his donation. Thanks a lot. - [Aadit Kamat](https://github.com/aaditkamat) find the tool useful and showed support with his donation. A big thanks to him. - [Jean-Michel Fayard](https://github.com/jmfayard) used the generator to create his GitHub Profile README and he loved it. Thanks to him for showing support to the tool with the donation. ## ๐ SupportDeveloped with โค๏ธ in India ๐ฎ๐ณ