https://github.com/rajk3770/Github-Profile-Readme-Creator

Generate user-friendly, intuitive and dynamic markdown for your profile README, in less than a minute!
https://github.com/rajk3770/Github-Profile-Readme-Creator

markdown markdown-generator profile profile-readme profile-readme-generator readme readme-generator

Last synced: about 1 month ago
JSON representation

Generate user-friendly, intuitive and dynamic markdown for your profile README, in less than a minute!

• Host: GitHub
• URL: https://github.com/rajk3770/Github-Profile-Readme-Creator
• Owner: rajk3770
• Created: 2020-08-03T15:43:07.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-08-06T05:44:30.000Z (over 4 years ago)
• Last Synced: 2023-03-04T04:03:41.358Z (about 2 years ago)
• Topics: markdown, markdown-generator, profile, profile-readme, profile-readme-generator, readme, readme-generator
• Language: CSS
• Homepage: https://github-profile-readme-creator.web.app/
• Size: 25.4 MB
• Stars: 51
• Watchers: 3
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-github-profile - Github Profile Readme Creator

README

        






 Github Profile Readme Creator 

Create a README.md file for your profile in less than a minute!




  



The website for this source code is deployed 

here.




:star: Star me on GitHub — It helps!


 

 


  Usage •

  Features •

  Demo •

  Screenshots •

  Demo Output •

  Contribute



---

## Usage

1. Login to your Github account and create a new public repository with the same name as your username.

2. Initialize this repository with a readme.md file which would then be visible on your home page.

3. Open the website deployed using the above source code by clicking [here](https://github-profile-readme-creator.web.app) and fill in the details you want to display

to your visitors.

4. Copy/Download the markdown dynamically generated by filling the form.

5. Paste the markdown content to your readme.md file (Created in step 2) and commit the changes.

6. Congratulations! Your profile should be visible with a readme.md file now.

## Features

* Displays Basic information in user-friendly and intutitve way.

* Badges for all social media links and portfolio.

* Link your Resume to your Github Profile.

* Monitor hits on your profile by `Profile Views`.

* Get Stats for your github profile such as `Total Stars`, `Total Commits`, `Total Pull Requests` and many more.

* Get distribution on various programming languages used by you.

## Demo

![Demo](https://github.com/rajk3770/Github-Profile-Readme-Creator/blob/master/screenshots/Demo.gif)

## Screenshots





## Demo Output



## Contributions

Contributions are welcomed! <3 


Open an issue or a pull request to contribute.