[简体中文](./README.md) | [English](./README_EN.md)

![GitHub Freshness](./docs/img/github-freshness-marquee.png)

# GitHub Freshness

GitHub Freshness highlights update times across GitHub repositories, files, and search results, helping you quickly see whether a project is still actively maintained.

The project is available as a Chrome extension and a Tampermonkey userscript. The Chrome extension is officially available in the Chrome Web Store: [Install GitHub Freshness from the Chrome Web Store](https://chromewebstore.google.com/detail/github-freshness/eelkgplabammohbgakcoehekeefgahoj).

## Features

- Highlight recent and older updates using a configurable freshness period.
- Work on repository file lists, tree views, and GitHub search results.
- Customize background, text, and file icon colors for light and dark themes.
- Sort files by update time and display relative times as `yyyy-MM-dd`.
- Import and export settings as JSON without including the AWESOME token.
- Use the settings panel in Chinese or English and open it directly from GitHub pages.
- Optionally enhance Awesome-style lists with repository star counts and latest update dates.

## Preview

### Repository freshness

![Repository freshness](./docs/img/screenshots/repository-overview-light.png)

### Settings panel

![GitHub Freshness settings panel](./docs/img/screenshots/settings-panel.png)

### Awesome-style projects

![Awesome project preview](./docs/img/awesome-xxx.png)

See the [complete preview](https://rational-stars.github.io/GitHub-Freshness/en/preview.html) for tree views, search results, and dark-theme screenshots.

## Installation

### Chrome extension

[Install GitHub Freshness from the Chrome Web Store](https://chromewebstore.google.com/detail/github-freshness/eelkgplabammohbgakcoehekeefgahoj).

The Chrome extension source code is not included in this public repository. Do not install extension files from unofficial sources.

### Tampermonkey userscript

1. Install [Tampermonkey](https://www.tampermonkey.net/).
2. Install [GitHub Freshness from Greasy Fork](https://greasyfork.org/zh-CN/scripts/524465-github-freshness).
3. Open a GitHub repository or search page, then use the GitHub Freshness icon to open the settings panel.

## Documentation and privacy

- [Documentation](https://rational-stars.github.io/GitHub-Freshness/en/)
- [Getting started](https://rational-stars.github.io/GitHub-Freshness/en/getting-started.html)
- [Feature settings](https://rational-stars.github.io/GitHub-Freshness/en/diy-settings/)
- [Changelog](https://rational-stars.github.io/GitHub-Freshness/en/version-log.html)
- [Privacy Policy](https://rational-stars.github.io/GitHub-Freshness/en/privacy/)

The public repository contains the source-available userscript and project documentation. The Chrome extension is distributed separately and its source code is not published here.

## Feedback and community

- [GitHub Issues](https://github.com/rational-stars/GitHub-Freshness/issues)
- [Telegram community](https://t.me/GitHubFreshness)
- [Homepage](https://home.rational-stars.top/)

If GitHub Freshness helps you, please consider giving the repository a Star.

## License

The public source code and documentation in this repository are available under the [PolyForm Noncommercial License 1.0.0](./LICENSE):

- You may use them for personal study, education, research, and other noncommercial projects.
- You may modify and redistribute them for noncommercial purposes, provided that you retain the copyright and license notices.
- Companies, commercial organizations, and all other commercial use, including internal company use, require separate written permission.

For commercial licensing, contact `rational.stars127@gmail.com`.