Skip to content

Commit 0676e97

Browse files
mrz1836mrz1836
committed
docs(README): enhance project structure and badge visibility
1 parent ad7feae commit 0676e97

File tree

1 file changed

+90
-83
lines changed

1 file changed

+90
-83
lines changed

‎README.md‎

Lines changed: 90 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -1,92 +1,99 @@
1-
# 🔁 go-tx-map
2-
> High-performance, concurrent-safe Go data structures for transaction hash and key-value mapping
1+
<div align="center">
2+
3+
# 🔁&nbsp;&nbsp;go-tx-map
4+
5+
**High-performance, concurrent-safe Go data structures for transaction hash and key-value mapping.**
36

47
<br/>
58

6-
<table>
7-
<thead>
8-
<tr>
9-
<th>CI&nbsp;/&nbsp;CD</th>
10-
<th>Quality&nbsp;&amp;&nbsp;Security</th>
11-
<th>Docs&nbsp;&amp;&nbsp;Meta</th>
12-
<th>Community</th>
13-
</tr>
14-
</thead>
15-
<tbody>
16-
<tr>
17-
<td valign="top" align="left">
18-
<a href="https://github.com/bsv-blockchain/go-tx-map/releases">
19-
<img src="https://img.shields.io/github/release-pre/bsv-blockchain/go-tx-map?logo=github&style=flat" alt="Latest Release">
20-
</a><br/>
21-
<a href="https://github.com/bsv-blockchain/go-tx-map/actions">
22-
<img src="https://img.shields.io/github/actions/workflow/status/bsv-blockchain/go-tx-map/fortress.yml?branch=master&logo=github&style=flat" alt="Build Status">
23-
</a><br/>
24-
<a href="https://github.com/bsv-blockchain/go-tx-map/actions">
25-
<img src="https://github.com/bsv-blockchain/go-tx-map/actions/workflows/codeql-analysis.yml/badge.svg?style=flat" alt="CodeQL">
26-
</a><br/>
27-
<a href="https://sonarcloud.io/project/overview?id=bsv-blockchain_go-tx-map">
28-
<img src="https://sonarcloud.io/api/project_badges/measure?project=bsv-blockchain_go-tx-map&metric=alert_status&style-flat" alt="SonarCloud">
29-
</a>
30-
</td>
31-
<td valign="top" align="left">
32-
<a href="https://goreportcard.com/report/github.com/bsv-blockchain/go-tx-map">
33-
<img src="https://goreportcard.com/badge/github.com/bsv-blockchain/go-tx-map?style=flat" alt="Go Report Card">
34-
</a><br/>
35-
<a href="https://app.codecov.io/gh/bsv-blockchain/go-tx-map/tree/master">
36-
<img src="https://codecov.io/gh/bsv-blockchain/go-tx-map/branch/master/graph/badge.svg?style=flat" alt="Code Coverage">
37-
</a><br/>
38-
<a href="https://scorecard.dev/viewer/?uri=github.com/bsv-blockchain/go-tx-map">
39-
<img src="https://api.scorecard.dev/projects/github.com/bsv-blockchain/go-tx-map/badge?logo=springsecurity&logoColor=white" alt="OpenSSF Scorecard">
40-
</a><br/>
41-
<a href=".github/SECURITY.md">
42-
<img src="https://img.shields.io/badge/security-policy-blue?style=flat&logo=springsecurity&logoColor=white" alt="Security policy">
43-
</a>
44-
</td>
45-
<td valign="top" align="left">
46-
<a href="https://golang.org/">
47-
<img src="https://img.shields.io/github/go-mod/go-version/bsv-blockchain/go-tx-map?style=flat" alt="Go version">
48-
</a><br/>
49-
<a href="https://pkg.go.dev/github.com/bsv-blockchain/go-tx-map?tab=doc">
50-
<img src="https://pkg.go.dev/badge/github.com/bsv-blockchain/go-tx-map.svg?style=flat" alt="Go docs">
51-
</a><br/>
52-
<a href=".github/AGENTS.md">
53-
<img src="https://img.shields.io/badge/AGENTS.md-found-40b814?style=flat&logo=openai" alt="AGENTS.md rules">
54-
</a><br/>
55-
<a href="https://magefile.org/">
56-
<img src="https://img.shields.io/badge/mage-powered-brightgreen?style=flat&logo=probot&logoColor=white" alt="Mage Powered">
57-
</a><br/>
58-
<a href=".github/dependabot.yml">
59-
<img src="https://img.shields.io/badge/dependencies-automatic-blue?logo=dependabot&style=flat" alt="Dependabot">
60-
</a>
61-
</td>
62-
<td valign="top" align="left">
63-
<a href="https://github.com/bsv-blockchain/go-tx-map/graphs/contributors">
64-
<img src="https://img.shields.io/github/contributors/bsv-blockchain/go-tx-map?style=flat&logo=contentful&logoColor=white" alt="Contributors">
65-
</a><br/>
66-
<a href="https://github.com/bsv-blockchain/go-tx-map/commits/master">
67-
<img src="https://img.shields.io/github/last-commit/bsv-blockchain/go-tx-map?style=flat&logo=clockify&logoColor=white" alt="Last commit">
68-
</a><br/>
69-
<a href="https://github.com/sponsors/bsv-blockchain">
70-
<img src="https://img.shields.io/badge/sponsor-BSV-181717.svg?logo=github&style=flat" alt="Sponsor">
71-
</a><br/>
72-
</td>
73-
</tr>
74-
</tbody>
75-
</table>
9+
<a href="https://github.com/bsv-blockchain/go-tx-map/releases"><img src="https://img.shields.io/github/release-pre/bsv-blockchain/go-tx-map?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/bsv-blockchain/go-tx-map?style=flat-square&logo=go&color=00ADD8" alt="Go Version"></a>
11+
<a href="https://github.com/bsv-blockchain/go-tx-map/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-OpenBSV-blue?style=flat-square" alt="License"></a>
7612

7713
<br/>
7814

79-
## 🗂️ Table of Contents
80-
* [Installation](#-installation)
81-
* [Documentation](#-documentation)
82-
* [Examples & Tests](#-examples--tests)
83-
* [Benchmarks](#-benchmarks)
84-
* [Code Standards](#-code-standards)
85-
* [AI Compliance](#-ai-compliance)
86-
* [Maintainers](#-maintainers)
87-
* [Contributing](#-contributing)
88-
* [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/bsv-blockchain/go-tx-map/actions"><img src="https://img.shields.io/github/actions/workflow/status/bsv-blockchain/go-tx-map/fortress.yml?branch=master&label=build&logo=github&style=flat-square" alt="Build"></a>
22+
<a href="https://github.com/bsv-blockchain/go-tx-map/actions"><img src="https://img.shields.io/github/last-commit/bsv-blockchain/go-tx-map?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/bsv-blockchain/go-tx-map"><img src="https://goreportcard.com/badge/github.com/bsv-blockchain/go-tx-map?style=flat-square" alt="Go Report"></a>
29+
<a href="https://codecov.io/gh/bsv-blockchain/go-tx-map"><img src="https://codecov.io/gh/bsv-blockchain/go-tx-map/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/bsv-blockchain/go-tx-map"><img src="https://api.scorecard.dev/projects/github.com/bsv-blockchain/go-tx-map/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/bsv-blockchain/go-tx-map/graphs/contributors"><img src="https://img.shields.io/github/contributors/bsv-blockchain/go-tx-map?style=flat-square&color=orange" alt="Contributors"></a>
46+
<a href="https://github.com/sponsors/bsv-blockchain"><img src="https://img.shields.io/badge/sponsor-BSV-181717.svg?logo=github&style=flat-square" alt="Sponsor"></a>
47+
</td>
48+
</tr>
49+
</table>
50+
51+
</div>
8952

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>
9097
<br/>
9198

9299
## 📦 Installation
@@ -327,4 +334,4 @@ The most basic way to show your support is to star :star2: the project, or to ra
327334

328335
## 📝 License
329336

330-
[![License](https://img.shields.io/badge/license-OpenBSV-blue?style=flat&logo=springsecurity&logoColor=white)](LICENSE)
337+
[![License](https://img.shields.io/badge/license-OpenBSV-blue?style=flat-square)](LICENSE)

0 commit comments

Comments
 (0)