Skip to content

Commit

Permalink
feat: extend README.
Browse files Browse the repository at this point in the history
  • Loading branch information
jochumdev committed Feb 23, 2025
1 parent f442d0c commit a7eef09
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,36 @@
# go-orb/examples

Contains examples and benchmarks for go-orb.

## Available examples

### [benchmarks/event](benchmarks/event)

A benchmark for running RPC requests over the event plugins, currently theres only the natsjs backend.

### [benchmarks/rps](benchmarks/rps)

A benchmark for running requests-per-second (rps) for a go-orb/server.

The rps benchmark sends X bytes (default `1000`) to server which echoes it to the client.

### [event/simple](event/simple)

A simple example of RPC requests over the event plugins, currently theres only the natsjs backend.

### [rest/middleware](rest/middleware)

A simple example of a go-orb service and client with a REST middleware.

In it's [config](rest/middleware/config) folder you can find a variaty of config files for different transports as well as logging options and registries. All of them run with the same code/binary.

## Authors

### go-orb

- [David Brouwer](https://github.com/Davincible)
- [René Jochum](https://github.com/jochumdev)

## License

go-orb is Apache 2.0 licensed and is based on go-micro.

0 comments on commit a7eef09

Please sign in to comment.