Deprecation Notice

Reimagined Readme is currently undergoing deprecation. Further information can be found at issue #32 regarding it. Thank you for your support.

Reimagined Readme

GitHub readme widgets are too seperated and you need to add 4 different widgets with all different styles to show your GitHub statistics. Reimagined Readme tries to fix this problem by giving a layout to your readme that does not trigger OCD.

Example Widget:

How to install

To create a custom widget we have a API route https://myreadme.vercel.app/api/embed/YOURNAME replacing yourname with well uh yourname.

Adding Widgets (Populating your Widget)

To populate your widget with your contribution stats, top repositories, or your commit graph you need to define which panels should be in the widget so you customize your own widget to your liking. We can do this through adding the url parameter panels https://myreadme.vercel.app/api/embed/YOURNAME?panels=. The order you put the panels is important as they will be reordered dependent on their size.

Valid Panels Include

• userstatistics - (Commit data [Year, Month, Week], PRs, Issues)

• toprepositories - (Top starred repositories you own/have contributed to)

• toplanguages - (Your top languages ranked by amount of commits using them)

• commitgraph - (A graph of your commit engagement to GitHub)

• userwelcome - (A welcome text your profile)

More panels will be added in the future, check issues for upcoming panels.

Using one panel only

Maybe a panel we have developed is superior and you want to add it to your GitHub profile but have other widgets from a different project. To do this, use the above steps but only include one panel in the panels list.

Credits:

• github-contribution-stats [MIT] - A SVG Based Github Contribution Stats Project (Used as base for SVG)

• devicon [MIT] - Developer Icons (Used for Language Logos)

• Svelte Logo [Branding Guideline] - Utilized for identifying the Svelte language. (SvelteJS, along with its contributors and community are not affiliated with, sponsoring, or endorsing this project. For more information on Svelte's branding guidelines, visit their official repository.)

• R Logo [CC-BY-SA 4.0] - Utilized for identifying the R language. (The R Project and R Foundation, along with its contributors, has no association, sponsorship, or endorsement connection with this project. For further details on the R logo and its usage, please refer to their website and logo use guidelines which can be found here.)

• FeatherIcons [MIT] - Open Source Icons (Used for some icons on the widget)

• Fluent Emoji by Microsoft [MIT] There is an ongoing conversation regarding the license. - Modern Emoji's (Used as the logo)

• D3 [ISC] - Graphing SVG Path Logic (Used for Commit Graph)