Skip to content

docs: update README with installation and feature details #908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 293 commits into
base: all-contributors/add-Mohitmadhav
Choose a base branch
from
Open

docs: update README with installation and feature details #908

wants to merge 293 commits into from

Conversation

@Reethikaa05
Copy link

@Reethikaa05 Reethikaa05 commented Sep 27, 2025

Summary

This pull request improves the README documentation for the GitHub Profile Readme Generator project. It includes detailed installation steps, feature highlights, and contributing guidelines for better clarity and onboarding of new contributors.

Changes

  • Added step-by-step installation instructions for cloning, dependency installation, and running the app.
  • Highlighted key features such as GitHub stats, visitor counter, Wakatime integration, and dynamic blogs.
  • Updated contributing section with GitHub Flow instructions.
  • Added credits and acknowledgments for libraries, tools, and sponsors used in the project.
  • Improved formatting and readability for easier understanding.

Benefits

  • New contributors can quickly set up the project and understand its capabilities.
  • Ensures uniformity and clarity in documentation.
  • Provides clear guidance on how to contribute and submit pull requests.

rahuldkjain and others added 30 commits October 6, 2020 23:01
@rahuldkjain
Merge pull request rahuldkjain#177 from rahuldkjain/all-contributors/…
25b1943 
…add-jaideepghosh

docs: add jaideepghosh as a contributor
@rahuldkjain
Merge branch 'master' into all-contributors/add-KKVANONYMOUS
7c3c64e
@rahuldkjain
Merge pull request rahuldkjain#203 from rahuldkjain/all-contributors/…
19b6a99 
…add-KKVANONYMOUS

docs: add KKVANONYMOUS as a contributor
@rahuldkjain
[add]: pr-template
559949d
@rahuldkjain
[fix]: typo in pr-template
a1dfb87
@rahuldkjain
Merge pull request rahuldkjain#244 from rahuldkjain/pr-template
008f2f8 
[add]: pr-template
@rahuldkjain
Merge pull request rahuldkjain#226 from Maddoxx88/patch-6
cb124b7 
[add]: Twitter Username Validation
@msriaz
fixing warning in local environment
f599872
@thauska
Merge branch 'master' of https://github.com/rahuldkjain/github-profil…
980f970 
…e-readme-generator
@thauska
[feat]: modify footer as requested
27b01cc
@j23saw
Merge branch 'master' of https://github.com/rahuldkjain/github-profil…
33ed98a 
…e-readme-generator into master
@rahuldkjain
Merge pull request rahuldkjain#246 from thauska/master
0ca556a 
[update]: footer with new design
@j23saw
fix search
b83adbc
@j23saw
Merge branch 'master' of https://github.com/rahuldkjain/github-profil…
064b827 
…e-readme-generator into master
@j23saw
fix search 1
75eb587
@j23saw
fix search 1
4b08b2f
@j23saw
fix search 2
21f2934
@j23saw
Merge branch 'master' of https://github.com/j23saw/github-profile-rea…
d1c1ab4 
…dme-generator into master
@j23saw
fix search 3
361c52b
fixed broken cockroachdb icon link
ca55d9e
@j23saw
fix search 4
e948dd1
@j23saw
clean code
c7e0901
CustomizeOptions component
8d4ac6d
@rahuldkjain
Merge pull request rahuldkjain#250 from kunaljain0212/cockroachicon
fa1dcf2 
[fix]: broken cockroachdb icon link
@rahuldkjain
Merge pull request rahuldkjain#241 from Mohitmadhav/Issue-#228
8809fb7 
[update] gatsby-plugin-sharp version
@j23saw
resolve changes
e8c1127
@j23saw
Merge branch 'master' of https://github.com/rahuldkjain/github-profil…
43d626f 
…e-readme-generator into master
@j23saw
add search fallback
5e63c40
@j23saw
indent
b719553
Make customize box logic reusable by pulling up into AddonsItem and c…
ae6ddfb 
…reating CustomizeOptions component
rahuldkjain and others added 29 commits October 21, 2021 08:46
@rahuldkjain
Merge pull request rahuldkjain#456 from RetiFier/valdate_json_upload
63347fc 
Add Validation JSON Upload Under Config options
@rahuldkjain
Merge pull request rahuldkjain#458 from MrDoomy/feat/better-checkboxes
ededb4b 
Using toggle switches instead of checkboxes
@rahuldkjain
Merge pull request rahuldkjain#460 from BerniWittmann/master
b406f4d 
feat: add ifttt to automation
@rahuldkjain
Merge pull request rahuldkjain#464 from mehabhalodiya/patch1
646c080 
Adds "pandas" and "seaborn" in AI/ML
@rahuldkjain
Merge pull request rahuldkjain#463 from pranansh-s/master
bf62cec 
[add]: Nim-Programming language
@rahuldkjain
Merge pull request rahuldkjain#465 from chandrikadeb7/kafka-svg-fix
793513d 
Kafka svg fix
@ajvideira
Fix nextjs broken logo url
2109192
@rahuldkjain
Merge pull request rahuldkjain#484 from ajvideira/nextjs-logo-fix
938a8a9 
fix: nextjs broken logo url
@rahuldkjain
fix: few ESLint warnings
f04dc76
@rahuldkjain
fix: npm version in .yml
8c84e91
@rahuldkjain
fix node version
6ff29bc
@rahuldkjain
add before script in travis.yml
1bffabd
@rahuldkjain
make node version 14
d33d139
@rahuldkjain
Merge pull request rahuldkjain#493 from rahuldkjain/enhancement/fix-w…
fb6389f 
…arnings

fix: few ESLint warnings
@rahuldkjain
intial eslint pre-commit setup
004401a
@rahuldkjain
fix: eslinting
9ba8ccf
@rahuldkjain
Merge pull request rahuldkjain#496 from rahuldkjain/enhancement/issue…
a0e34df 
…-495

Enhancement/issue 495
@rahuldkjain
remove files
8899046
@rahuldkjain
Merge pull request rahuldkjain#498 from rahuldkjain/issue-497
b23cab5 
fix: issue-497
@rahuldkjain
improve html.jsx
7898e38
@rahuldkjain
Merge pull request rahuldkjain#500 from rahuldkjain/issue-499
8947cb3 
fix: html.jsx linting
feature: add hashnode to socials input and preview
71d1faf 
closes rahuldkjain#452
fix: change placeholder to include the 'with @'
9b24ae6
docs: add content to readme
5e0cd2e
@rahuldkjain
Merge pull request rahuldkjain#501 from techieeliot/issue-452-hasnode
c919601 
feature: add hashnode to socials input and preview
@rahuldkjain
fix: linting errors
3461a5b
@rahuldkjain
Merge pull request rahuldkjain#564 from rahuldkjain/hotfix/icons
c83a129 
fix: linting errors
@rahuldkjain
fix: rahuldkjain#565
f4b2f5c
@rahuldkjain
Merge pull request rahuldkjain#568 from rahuldkjain/hotfix/skills
888aff3 
fix: rahuldkjain#565
@rahuldkjain rahuldkjain added the v1-deprecated V1 issues/PRs that are deprecated (no longer supported) label Oct 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

v1-deprecated V1 issues/PRs that are deprecated (no longer supported)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.