Skip to content

Commit f9ddbf9

Browse files
committed
Add CI workflow for automated testing and update README with examples
1 parent 4db7403 commit f9ddbf9

2 files changed

Lines changed: 22 additions & 1 deletion

File tree

.github/workflows/ci.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
pull_request:
6+
7+
jobs:
8+
test:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v4
12+
- uses: actions/setup-go@v5
13+
with:
14+
go-version: '1.24'
15+
- run: go test ./...

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Adaptive Rate Limit
22

3+
![CI](https://github.com/bhatpriyanka8/adaptiveratelimit/actions/workflows/ci.yml/badge.svg)
4+
[![Go Report Card](https://goreportcard.com/badge/github.com/bhatpriyanka8/adaptiveratelimit)](https://goreportcard.com/report/github.com/bhatpriyanka8/adaptiveratelimit)
5+
[![Go Reference](https://pkg.go.dev/badge/github.com/bhatpriyanka8/adaptiveratelimit.svg)](https://pkg.go.dev/github.com/bhatpriyanka8/adaptiveratelimit)
6+
![License](https://img.shields.io/badge/license-MIT-blue.svg)
7+
![Go](https://img.shields.io/badge/go-1.24+-blue)
8+
39
An adaptive rate limiter for Go that dynamically adjusts throughput
410
based on observed latency and error rates.
511

@@ -73,6 +79,7 @@ limiter.Record(time.Since(start), err)
7379
## Examples
7480

7581
For Runnable examples, refer
82+
7683
[HTTP Example](https://github.com/bhatpriyanka8/adaptiveratelimit/tree/main/examples/http)
7784

7885
[gRPC Example](https://github.com/bhatpriyanka8/adaptiveratelimit/tree/main/examples/grpc)
@@ -83,7 +90,6 @@ cd examples/http
8390
go run main.go
8491
```
8592

86-
go run main.go
8793
## Disclaimer
8894

8995
This project is developed and maintained in a personal capacity and

0 commit comments

Comments
 (0)