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
Что это такое?GitHub Trends создаёт настраиваемые карточки со статистикой для README вашего профиля на GitHub, вычисляя реальные показатели вашей активности через GitHub API — количество написанных строк кода по языкам, репозиториям и в динамике по времени.
Это сайт, где нужно регистрироваться, или что-то, что я устанавливаю?Это размещённый в интернете веб-сервис, а не программа для установки: вы регистрируетесь на githubtrends.io и встраиваете свою карточку в README как динамически генерируемое изображение с помощью Markdown-фрагмента.
Как добавить карточку в свой профиль?После регистрации вставьте предложенную строку в Markdown своего README, подставив своё имя пользователя. И всё — карточка появится прямо в профиле как динамическое изображение.
Мне нужен свой GitHub-токен или API-ключ, чтобы всё это работало?Нет — достаточно просто зарегистрироваться на GitHub Trends, и это вся настройка; сервис сам берёт на себя работу с GitHub API. Ничего не нужно устанавливать или настраивать у себя.
GitHub Trends ещё развивается?Нет — репозиторий проекта на GitHub заархивирован, так что разработка остановлена: новых функций и исправлений не будет. Зарегистрироваться и пользоваться сервисом по-прежнему можно, но относитесь к нему как к необслуживаемому проекту.
Карточки работают везде или только на определённых устройствах?Сервис работает в браузере на githubtrends.io, а созданные карточки — обычные изображения, поэтому они отображаются везде, где GitHub показывает Markdown.
Что такое GitHub Wrapped?Сопутствующая функция, которую README рекламирует в самом верху: ваш GitHub Wrapped, размещённый на githubwrapped.io — обзор вашей активности на GitHub в формате «wrapped», которым можно поделиться.
Чем это отличается от GitHub Readme Stats?Похожие инструменты учитывают только ваши публичные репозитории. GitHub Trends вычисляет показатели по вашим отдельным коммитам, поэтому учитывается и вклад в чужие и совместные проекты — и это первый сервис, который показывает количество строк кода (LOC) по языкам и репозиториям. В качестве источника вдохновения он называет GitHub Readme Stats.
Могу ли я настроить карточку, не пользуясь сайтом?Да — веб-интерфейс сделан для удобной настройки, а ещё можно создавать и конфигурировать карточки напрямую через API; доступные варианты описаны в docs/API.md.
Creator
avgupta456
Size
4.2 MB
Stars
16K
Updated
CommitJan 25
Age
5y
Commits · 90 Days