add readme

Memory Efficiency: The package uses probabilistic data structures which offer significant memory savings compared to exact counting methods, especially beneficial for large datasets or streams.
Performance: Incorporates fast, thread-local random number generation and efficient hash functions, optimizing performance for high-throughput applications.
Scalability: Suitable for scaling to large datasets with minimal computational and memory footprint increases.
Thread-Safety: Features such as atomic operations ensure thread safety, making the package suitable for concurrent applications.
kelindar · Feb 26, 2024 · 9fe3ccc · 9fe3ccc
1 parent 21becb0
commit 9fe3ccc
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 0 deletions.
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1 @@
+github: [kelindar]
diff --git a/.github/logo.pdn b/.github/logo.pdn
diff --git a/.github/logo.png b/.github/logo.png
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,27 @@
+name: Test
+on: [push, pull_request]
+env:
+  GITHUB_TOKEN: ${{ secrets.COVERALLS_TOKEN }}
+  GO111MODULE: "on"
+jobs:
+  test:
+    name: Test with Coverage
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Go
+        uses: actions/setup-go@v1
+        with:
+          go-version: "1.22"
+      - name: Check out code
+        uses: actions/checkout@v2
+      - name: Install dependencies
+        run: |
+          go mod download
+      - name: Run Unit Tests
+        run: |
+          go test -tags noasm -race -covermode atomic -coverprofile=profile.cov ./...
+          go test -race ./...
+      - name: Upload Coverage
+        uses: shogo82148/actions-goveralls@v1
+        with:
+          path-to-profile: profile.cov
diff --git a/README.md b/README.md
diff --git a/main/main.go → example/main.go b/main/main.go → example/main.go