Skip to content

Commit bad2d8d

Browse files
google-labs-jules[bot]google-labs-jules[bot]
committed
docs: update README.md to new template
Replaced the top section of the README.md with a new, standardized template. This includes updating badges to a consistent style and creating a new "Project Navigation" table that links to all major sections of the document.
1 parent abfd34b commit bad2d8d

1 file changed

Lines changed: 97 additions & 87 deletions

File tree

‎README.md‎

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

7813
<br/>
7914

80-
## 🗂️ Table of Contents
81-
* [Installation](#-installation)
82-
* [Usage](#-usage)
83-
* [Documentation](#-documentation)
84-
* [Examples & Tests](#-examples--tests)
85-
* [Benchmarks](#-benchmarks)
86-
* [Code Standards](#-code-standards)
87-
* [AI Compliance](#-ai-compliance)
88-
* [Maintainers](#-maintainers)
89-
* [Contributing](#-contributing)
90-
* [License](#-license)
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-sanitize/actions"><img src="https://img.shields.io/github/actions/workflow/status/mrz1836/go-sanitize/fortress.yml?branch=master&label=build&logo=github&style=flat-square" alt="Build"></a>
22+
<a href="https://github.com/mrz1836/go-sanitize/actions"><img src="https://img.shields.io/github/last-commit/mrz1836/go-sanitize?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-sanitize"><img src="https://goreportcard.com/badge/github.com/mrz1836/go-sanitize?style=flat-square" alt="Go Report"></a>
29+
<a href="https://codecov.io/gh/mrz1836/go-sanitize"><img src="https://codecov.io/gh/mrz1836/go-sanitize/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-sanitize"><img src="https://api.scorecard.dev/projects/github.com/mrz1836/go-sanitize/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-sanitize/graphs/contributors"><img src="https://img.shields.io/github/contributors/mrz1836/go-sanitize?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>
50+
51+
</div>
52+
53+
<br/>
54+
<br/>
9155

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="#-usage"><code>Usage</code></a>
69+
</td>
70+
<td align="center" width="33%">
71+
🧪&nbsp;<a href="#-examples--tests"><code>Examples&nbsp;&&nbsp;Tests</code></a>
72+
</td>
73+
</tr>
74+
<tr>
75+
<td align="center">
76+
📚&nbsp;<a href="#-documentation"><code>Documentation</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="#-contributing"><code>Contributing</code></a>
94+
</td>
95+
</tr>
96+
<tr>
97+
<td align="center" colspan="3">
98+
👥&nbsp;<a href="#-maintainers"><code>Maintainers</code></a>
99+
</td>
100+
</tr>
101+
</table>
92102
<br/>
93103

94104
## 📦 Installation

0 commit comments

Comments
 (0)