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…

15.9K ·GitHub
archived
这是干什么的?GitHub Trends 可以为你的 GitHub 个人资料 README 生成可自定义的统计卡片,它通过 GitHub API 计算你真实的贡献数据——写了多少行代码,按语言、按仓库以及随时间变化的统计。
它是一个需要注册的网站,还是需要安装的软件?是一个在线托管的服务,不需要安装:你在 githubtrends.io 注册后,用一段 Markdown 代码把卡片作为动态生成的图片嵌入到 README 里。
怎么把卡片放到我的个人主页上?注册之后,把提供的字符串粘贴到 README 的 Markdown 里,替换成你自己的用户名就行了——卡片会作为动态图片直接显示在你的个人主页上。
我需要自己的 GitHub token 或 API 密钥才能用吗?不需要——只要注册一个 GitHub Trends 账号就完成全部设置,GitHub API 相关的事情由服务自己处理。本地不用安装或配置任何东西。
GitHub Trends 还在活跃开发吗?不在了——GitHub 仓库已被归档,开发已经停止:不再有新功能和修复。你仍然可以注册使用这项服务,但请把它当作无人维护的项目。
卡片在任何地方都能显示吗,还是只能在某些设备上用?它在 githubtrends.io 的浏览器里运行,生成的卡片就是普通图片,所以只要 GitHub 能显示 Markdown 的地方都能正常渲染。
GitHub Wrapped 是什么?这是 README 在最显眼位置推广的一个配套功能:你的 GitHub Wrapped,托管在 githubwrapped.io——一份可分享的年度回顾式的 GitHub 活动总结。
它和 GitHub Readme Stats 有什么不同?类似的工具只统计你的公开仓库。GitHub Trends 是根据你的每一个 commit 来计算数据的,所以你对别人项目和协作项目的贡献也会被算进去——而且它是第一个展示按语言和仓库划分的代码行数(LOC)的。它也致谢 GitHub Readme Stats 是自己的灵感来源。
不用网站也能自定义卡片吗?可以——网页界面本身就是为方便自定义设计的,你也可以直接通过 API 来创建和配置卡片;docs/API.md 里说明了所有可用的选项。
Creator
avgupta456
Size
4.2 MB
Stars
15.9K
Updated
CommitJan 25
Age
5y
Commits · 90 Days