Skip to content

Commit a31dbd7

Browse files
committed
fix: minor updates, mvp description
1 parent b922c9d commit a31dbd7

2 files changed

Lines changed: 3 additions & 13 deletions

File tree

.github/AGENTS.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,7 @@ Additional `AGENTS.md` files **may exist in subdirectories** to provide more con
1818

1919
## 🔍 Project Overview
2020

21-
**go-lockfree-queue** is a production-ready scaffold for building new Go libraries with zero setup friction.
22-
It ships with opinionated defaults that reflect current best practices—clean project layout,
23-
module-aware dependency management, and Makefiles that automate everything from linting and race-condition
24-
testing to snapshot releases. Out of the box, GitHub Actions orchestrate CI/CD: unit tests (with `testify`),
25-
coverage upload to Codecov, static analysis via golangci-lint and CodeQL, vulnerability auditing with Nancy,
26-
and one-command releases through GoReleaser.
27-
28-
Beyond automation, the template supplies all the "undifferentiated heavy lifting" a maintainer usually
29-
adds manually: standard README and license, issue and PR templates, CODEOWNERS, semantic version tagging helpers,
30-
label synchronization, and optional Slack/Discord/Twitter release announcements. Example functions, fuzz tests and
31-
benchmarks are already wired in, so you can focus on writing library code instead of plumbing.
32-
Clone, rename a few placeholders, and you have a fully instrumented Go library that is ready for continuous
33-
delivery and open-source collaboration from day one.
21+
**go-lockfree-queue** is a production-ready Go package that provides a high-performance, lock-free queue implementation. It is designed for concurrent applications where low-latency and high-throughput are critical.
3422

3523
<br/>
3624

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,8 @@
9191
## 🧩 What's Inside
9292
Library for Lock Free Queue capabilities. A Lock Free Queue is a FIFO structure with operations to enqueue and dequeue generic values.
9393

94+
<br/>
95+
9496
## 📦 Installation
9597

9698
**go-lockfree-queue** requires a [supported release of Go](https://golang.org/doc/devel/release.html#policy).

0 commit comments

Comments
 (0)