Skip to content

Commit f6ff1b0

Browse files
authored
docs 🔍 (#608)
* fix misc link * fix resilience4g readme
1 parent e7abe95 commit f6ff1b0

File tree

1 file changed

+7
-44
lines changed

1 file changed

+7
-44
lines changed

go/resilience4g/README.md

+7-44
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,12 @@
1-
# Resilience4g - Go Implementation
1+
# Resilience4g
22

3-
This directory contains a Go implementation of resilience patterns inspired by Resilience4j. It provides a set of utilities for building resilient microservices in Go.
3+
Go resilience patterns inspired by Resilience4j.
44

55
## Features
6-
7-
- Circuit breaker pattern
86
- Rate limiting
9-
- Retry mechanisms
10-
- Bulkhead pattern
11-
- Timeout handling
12-
- Fallback strategies
13-
14-
## Building
15-
16-
This project uses both Go modules and Bazel for building:
17-
18-
```bash
19-
# Using Go
20-
go build ./...
21-
22-
# Using Bazel
23-
bazel build //go/resilience4g:...
24-
```
25-
26-
## Testing
27-
28-
```bash
29-
# Using Go
30-
go test ./...
31-
32-
# Using Bazel
33-
bazel test //go/resilience4g:...
34-
```
35-
36-
## Example Usage
37-
38-
```go
39-
// Example of using the circuit breaker
40-
breaker := resilience4g.NewCircuitBreaker(
41-
"my-service",
42-
resilience4g.WithFailureThreshold(5),
43-
resilience4g.WithResetTimeout(30 * time.Second),
44-
)
7+
- Circuit breaker (TODO)
8+
- Retry mechanisms (TODO)
9+
- Bulkhead (TODO)
4510

46-
result, err := breaker.Execute(func() (interface{}, error) {
47-
return someService.Call()
48-
})
49-
```
11+
## Usage
12+
TODO

0 commit comments

Comments
 (0)