github-trends README

The project's README from github.com/avgupta456/github-trends. As one markdown file: README.md.

GitHub Trends

SPECIAL: GitHub Wrapped

Check out your GitHub Wrapped at githubwrapped.io!

github-wrapped


GitHub Trends dives deep into the GitHub API to bring you exciting and impactful metrics about your code contributions. Generate insights on lines written by language, repository, and time. Easily embed dynamic images into your GitHub profile to share your statistics with the world. Check out some of the examples below:

Quickstart

First, visit https://api.githubtrends.io/auth/signup/public and create an account with GitHub Trends. Then, paste this string into your Markdown content, substituting your username.

[![GitHub Trends SVG](https://api.githubtrends.io/user/svg/avgupta456/langs)](https://githubtrends.io)

And voila, you get a card like above. Keep reading to learn more!

Unlike other projects which look at just your public repositories, GitHub Trends computes metrics based on your individual commits. If you commit to open-source projects, or have collaborators contribute to your own repositories, GitHub Trends will better measure your own code contributions. Through this method, GitHub Trends is the first project that allows users to surface lines of code written (LOC) by language and repository. Our web interface also allows for easier customization.

Usage

Website Workflow (Alpha)

Visit githubtrends.io to create an account and get started!

Have questions? Check out the demo!

image


API Workflow (Alpha)

Alternatively, you can communicate directly with the API to create and customize your cards. Read docs/API.md to learn more about the API and customizations.

FAQ

See docs/FAQ.md.

Contributing

See docs/CONTRIBUTING.md.

Acknowledgements

Much inspiration was taken from GitHub Readme Stats. If you haven't already, check it out and give it a star!

github-trends (avgupta456/github-trends)

Searching Database…

16K ·GitHub
archived
What is this?GitHub Trends generates customizable stat cards for your GitHub profile README, computing your real contribution metrics from the GitHub API — lines of code written, by language, repository, and over time.
Is it a website I sign up for, or something I install?A hosted web service, not something you install: you sign up at githubtrends.io and embed your card as a dynamically generated image in your README with a Markdown snippet.
How do I get a card onto my profile?After signing up, paste the provided string into your README's Markdown, substituting your username. That's it — the card shows up as a dynamic image right in your profile.
Do I need my own GitHub token or API key for this to work?No — signing up for a GitHub Trends account is all the setup there is; the service takes care of the GitHub API side. Nothing to install or configure locally.
Is GitHub Trends still actively developed?No — the GitHub repository has been archived, so development has stopped: no new features or fixes. You can still sign up and use the service, but treat it as unmaintained.
Do the cards work everywhere, or only on certain devices?It runs in the browser at githubtrends.io, and the generated cards are plain images, so they render anywhere GitHub displays Markdown.
What is GitHub Wrapped?A companion feature the README promotes right at the top: your GitHub Wrapped, hosted at githubwrapped.io — a shareable, wrapped-style recap of your GitHub activity.
How is it different from GitHub Readme Stats?Similar tools count only your public repositories. GitHub Trends computes metrics from your individual commits, so contributions to other people's and collaborative projects count too — and it's the first to surface lines of code (LOC) by language and repository. It credits GitHub Readme Stats as its inspiration.
Can I customize the card without using the website?Yes — the web interface is built for easy customization, and you can also create and configure cards directly through the API; docs/API.md documents the available options.
Creator
avgupta456
Size
4.2 MB
Stars
16K
Updated
CommitJan 25
Age
5y
Commits · 90 Days