Skip to content

Commit 93d86fc

Browse files
committed
whats about
1 parent 74206b4 commit 93d86fc

1 file changed

Lines changed: 53 additions & 0 deletions

File tree

README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# .github (Profile + Automation)
2+
3+
Costa Rica
4+
5+
[![GitHub](https://img.shields.io/badge/--181717?logo=github&logoColor=ffffff)](https://github.com/)
6+
[brown9804](https://github.com/brown9804)
7+
8+
Last updated: 2025-05-13
9+
10+
----------
11+
12+
> This repository holds the public **GitHub profile content** for *Microsoft Cloud Sandbox - Unofficial* and a small **GitHub Actions automation** that refreshes the visitor/view counter badge.
13+
14+
## What this is for
15+
16+
- **Profile hub**: the content in `profile/README.md` is intended to be displayed on the GitHub profile page (when this repository is the special `.github` repo for an organization).
17+
- **Visitor counter updates**: a scheduled GitHub Actions workflow updates the badge inside the profile README and writes view history to `metrics.json`.
18+
19+
## Repository layout
20+
21+
- `profile/README.md`
22+
- The main profile page content (about the Microsoft Cloud hub, disclaimers, and the view counter badge).
23+
- `.github/workflows/use-visitor-counter.yml`
24+
- GitHub Actions workflow that runs on a schedule / manual trigger to update the badge and regenerate `metrics.json`.
25+
- `metrics.json`
26+
- Generated historical view metrics (daily counts + uniques). This file is overwritten by the workflow.
27+
28+
## How to update
29+
30+
### Update the profile text
31+
32+
Edit `profile/README.md`.
33+
34+
### Refresh the visitor counter badge / metrics
35+
36+
- Run the workflow manually from GitHub: **Actions****Use Visitor Counter Logic****Run workflow**.
37+
- Or let it run automatically on the configured cron schedule.
38+
39+
## Secrets / permissions
40+
41+
The workflow expects a repository secret named `TRAFFIC_TOKEN` so it can read repository traffic insights.
42+
43+
## Notes
44+
45+
- The workflow uses an external tool repo (`brown9804/github-visitor-counter`) to generate the badge and `metrics.json`.
46+
- Manual edits to `metrics.json` are not recommended because the workflow will replace it on the next run.
47+
48+
<!-- START BADGE -->
49+
<div align="center">
50+
<img src="https://img.shields.io/badge/Total%20views-1280-limegreen" alt="Total views">
51+
<p>Refresh Date: 2026-01-06</p>
52+
</div>
53+
<!-- END BADGE -->

0 commit comments

Comments
 (0)