Skip to content

Commit 4de1607

Browse files
feat: Replace README header with modern template (#172)
Replaces the existing README header and table of contents with a new, modernized template. - Preserves the original icon and project description. - Selects and integrates the most relevant badges into the new layout. - Creates a new "Project Navigation" section with links to the main sections of the README, using `&nbsp;` for multi-word links to prevent wrapping. - Removes the old table of contents. Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
1 parent 7658762 commit 4de1607

1 file changed

Lines changed: 91 additions & 89 deletions

File tree

README.md

Lines changed: 91 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -1,97 +1,99 @@
1-
# 🗺️ go‑countries
2-
3-
> Go package providing comprehensive country data in all standard ISO formats
4-
5-
<table>
6-
<thead>
7-
<tr>
8-
<th>CI&nbsp;/&nbsp;CD</th>
9-
<th>Quality&nbsp;&amp;&nbsp;Security</th>
10-
<th>Docs&nbsp;&amp;&nbsp;Meta</th>
11-
<th>Community</th>
12-
</tr>
13-
</thead>
14-
<tbody>
15-
<tr>
16-
<td valign="top" align="left">
17-
<a href="https://github.com/mrz1836/go-countries/releases">
18-
<img src="https://img.shields.io/github/release-pre/mrz1836/go-countries?logo=github&style=flat" alt="Latest release">
19-
</a><br/>
20-
<a href="https://github.com/mrz1836/go-countries/actions">
21-
<img src="https://img.shields.io/github/actions/workflow/status/mrz1836/go-countries/fortress.yml?branch=master&logo=github&style=flat" alt="Build status">
22-
</a><br/>
23-
<a href="https://github.com/mrz1836/go-countries/actions">
24-
<img src="https://github.com/mrz1836/go-countries/actions/workflows/codeql-analysis.yml/badge.svg?style=flat" alt="CodeQL">
25-
</a><br/>
26-
<a href="https://github.com/mrz1836/go-countries/commits/master">
27-
<img src="https://img.shields.io/github/last-commit/mrz1836/go-countries?style=flat&logo=clockify&logoColor=white" alt="Last commit">
28-
</a>
29-
</td>
30-
<td valign="top" align="left">
31-
<a href="https://goreportcard.com/report/github.com/mrz1836/go-countries">
32-
<img src="https://goreportcard.com/badge/github.com/mrz1836/go-countries?style=flat" alt="Go Report Card">
33-
</a><br/>
34-
<a href="https://codecov.io/gh/mrz1836/go-countries">
35-
<img src="https://codecov.io/gh/mrz1836/go-countries/branch/master/graph/badge.svg?style=flat" alt="Code coverage">
36-
</a><br/>
37-
<a href="https://scorecard.dev/viewer/?uri=github.com/mrz1836/go-countries">
38-
<img src="https://api.scorecard.dev/projects/github.com/mrz1836/go-countries/badge?logo=springsecurity&logoColor=white" alt="Security policy">
39-
</a><br/>
40-
<a href=".github/SECURITY.md">
41-
<img src="https://img.shields.io/badge/security-policy-blue?style=flat&logo=springsecurity&logoColor=white" alt="Security policy">
42-
</a><br/>
43-
<a href="https://www.bestpractices.dev/projects/10767">
44-
<img src="https://www.bestpractices.dev/projects/10767/badge" alt="Best Practices">
45-
</a><br/>
46-
</td>
47-
<td valign="top" align="left">
48-
<a href="https://golang.org/">
49-
<img src="https://img.shields.io/github/go-mod/go-version/mrz1836/go-countries?style=flat" alt="Go version">
50-
</a><br/>
51-
<a href="https://pkg.go.dev/github.com/mrz1836/go-countries?tab=doc">
52-
<img src="https://pkg.go.dev/badge/github.com/mrz1836/go-countries.svg?style=flat" alt="Go docs">
53-
</a><br/>
54-
<a href=".github/AGENTS.md">
55-
<img src="https://img.shields.io/badge/AGENTS.md-found-40b814?style=flat&logo=openai" alt="AGENTS.md rules">
56-
</a><br/>
57-
<a href="https://github.com/mrz1836/mage-x">
58-
<img src="https://img.shields.io/badge/Mage-supported-brightgreen?style=flat&logo=go&logoColor=white" alt="MAGE-X Supported">
59-
</a><br/>
60-
<a href=".github/dependabot.yml">
61-
<img src="https://img.shields.io/badge/dependencies-automatic-blue?logo=dependabot&style=flat" alt="Dependabot">
62-
</a>
63-
</td>
64-
<td valign="top" align="left">
65-
<a href="https://github.com/mrz1836/go-countries/graphs/contributors">
66-
<img src="https://img.shields.io/github/contributors/mrz1836/go-countries?style=flat&logo=contentful&logoColor=white" alt="Contributors">
67-
</a><br/>
68-
<a href="https://github.com/sponsors/mrz1836">
69-
<img src="https://img.shields.io/badge/sponsor-MrZ-181717.svg?logo=github&style=flat" alt="Sponsor">
70-
</a><br/>
71-
<a href="https://mrz1818.com/?tab=tips&utm_source=github&utm_medium=sponsor-link&utm_campaign=go-countries&utm_term=go-countries&utm_content=go-countries">
72-
<img src="https://img.shields.io/badge/donate-bitcoin-ff9900.svg?logo=bitcoin&style=flat" alt="Donate Bitcoin">
73-
</a>
74-
</td>
75-
</tr>
76-
</tbody>
77-
</table>
1+
<div align="center">
2+
3+
# 🗺️&nbsp;&nbsp;go-countries
4+
5+
**Go package providing comprehensive country data in all standard ISO formats.**
786

797
<br/>
808

81-
## 🗂️ Table of Contents
9+
<a href="https://github.com/mrz1836/go-countries/releases"><img src="https://img.shields.io/github/release-pre/mrz1836/go-countries?include_prereleases&style=flat-square&logo=github&color=black" alt="Release"></a>
10+
<a href="https://golang.org/"><img src="https://img.shields.io/github/go-mod/go-version/mrz1836/go-countries?style=flat-square&logo=go&color=00ADD8" alt="Go Version"></a>
11+
<a href="https://github.com/mrz1836/go-countries/blob/master/LICENSE"><img src="https://img.shields.io/github/license/mrz1836/go-countries?style=flat-square&color=blue" alt="License"></a>
8212

83-
* [Installation](#-installation)
84-
* [Usage](#-usage)
85-
* [Documentation](#-documentation)
86-
* [Examples & Tests](#-examples--tests)
87-
* [Benchmarks](#-benchmarks)
88-
* [Code Standards](#-code-standards)
89-
* [AI Compliance](#-ai-compliance)
90-
* [Credits](#-credits)
91-
* [Maintainers](#-maintainers)
92-
* [Contributing](#-contributing)
93-
* [License](#-license)
13+
<br/>
14+
15+
<table align="center" border="0">
16+
<tr>
17+
<td align="right">
18+
<code>CI / CD</code> &nbsp;&nbsp;
19+
</td>
20+
<td align="left">
21+
<a href="https://github.com/mrz1836/go-countries/actions"><img src="https://img.shields.io/github/actions/workflow/status/mrz1836/go-countries/fortress.yml?branch=master&label=build&logo=github&style=flat-square" alt="Build"></a>
22+
<a href="https://github.com/mrz1836/go-countries/actions"><img src="https://img.shields.io/github/last-commit/mrz1836/go-countries?style=flat-square&logo=git&logoColor=white&label=last%20update" alt="Last Commit"></a>
23+
</td>
24+
<td align="right">
25+
&nbsp;&nbsp;&nbsp;&nbsp; <code>Quality</code> &nbsp;&nbsp;
26+
</td>
27+
<td align="left">
28+
<a href="https://goreportcard.com/report/github.com/mrz1836/go-countries"><img src="https://goreportcard.com/badge/github.com/mrz1836/go-countries?style=flat-square" alt="Go Report"></a>
29+
<a href="https://codecov.io/gh/mrz1836/go-countries"><img src="https://codecov.io/gh/mrz1836/go-countries/branch/master/graph/badge.svg?style=flat-square" alt="Coverage"></a>
30+
</td>
31+
</tr>
32+
33+
<tr>
34+
<td align="right">
35+
<code>Security</code> &nbsp;&nbsp;
36+
</td>
37+
<td align="left">
38+
<a href="https://scorecard.dev/viewer/?uri=github.com/mrz1836/go-countries"><img src="https://api.scorecard.dev/projects/github.com/mrz1836/go-countries/badge?style=flat-square" alt="Scorecard"></a>
39+
<a href=".github/SECURITY.md"><img src="https://img.shields.io/badge/policy-active-success?style=flat-square&logo=security&logoColor=white" alt="Security"></a>
40+
</td>
41+
<td align="right">
42+
&nbsp;&nbsp;&nbsp;&nbsp; <code>Community</code> &nbsp;&nbsp;
43+
</td>
44+
<td align="left">
45+
<a href="https://github.com/mrz1836/go-countries/graphs/contributors"><img src="https://img.shields.io/github/contributors/mrz1836/go-countries?style=flat-square&color=orange" alt="Contributors"></a>
46+
<a href="https://mrz1818.com/"><img src="https://img.shields.io/badge/donate-bitcoin-ff9900?style=flat-square&logo=bitcoin" alt="Bitcoin"></a>
47+
</td>
48+
</tr>
49+
</table>
9450

51+
</div>
52+
53+
<br/>
54+
<br/>
55+
56+
<div align="center">
57+
58+
### <code>Project Navigation</code>
59+
60+
</div>
61+
62+
<table align="center">
63+
<tr>
64+
<td align="center" width="33%">
65+
🚀&nbsp;<a href="#-installation"><code>Installation</code></a>
66+
</td>
67+
<td align="center" width="33%">
68+
🧪&nbsp;<a href="#-examples--tests"><code>Examples&nbsp;&&nbsp;Tests</code></a>
69+
</td>
70+
<td align="center" width="33%">
71+
📚&nbsp;<a href="#-documentation"><code>Documentation</code></a>
72+
</td>
73+
</tr>
74+
<tr>
75+
<td align="center">
76+
🤝&nbsp;<a href="#-contributing"><code>Contributing</code></a>
77+
</td>
78+
<td align="center">
79+
🛠️&nbsp;<a href="#-code-standards"><code>Code&nbsp;Standards</code></a>
80+
</td>
81+
<td align="center">
82+
⚡&nbsp;<a href="#-benchmarks"><code>Benchmarks</code></a>
83+
</td>
84+
</tr>
85+
<tr>
86+
<td align="center">
87+
🤖&nbsp;<a href="#-ai-compliance"><code>AI&nbsp;Compliance</code></a>
88+
</td>
89+
<td align="center">
90+
⚖️&nbsp;<a href="#-license"><code>License</code></a>
91+
</td>
92+
<td align="center">
93+
👥&nbsp;<a href="#-maintainers"><code>Maintainers</code></a>
94+
</td>
95+
</tr>
96+
</table>
9597
<br/>
9698

9799
## 📦 Installation

0 commit comments

Comments
 (0)