Skip to content

Commit 7dadcba

Browse files
committed
docs: update logo align
1 parent 6c805c3 commit 7dadcba

File tree

1 file changed

+26
-21
lines changed

1 file changed

+26
-21
lines changed

README.md

+26-21
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Protobox
2+
23
![GitHub release](https://img.shields.io/github/release/notjustmoney/protobox.svg)
34
![Go Report Card](https://goreportcard.com/badge/github.com/notjustmoney/protobox)
45
![GoDoc](https://godoc.org/github.com/notjustmoney/protobox?status.svg)
@@ -7,21 +8,14 @@
78

89
> For reliable delivery of In-process or Interprocess messages.
910
10-
Protobox is a reliable message delivery framework for Go, providing both in-process and network message delivery capabilities with type safety and transaction support.
11+
Protobox is a reliable message delivery framework for Go, providing both in-process and network message delivery capabilities with type
12+
safety and transaction support.
1113

14+
# Overview
1215

16+
<img align="right" width="40%" src="./logo/protobox-gopher.png" alt="protobox-gopher">
1317

14-
# Overview
15-
<div>
16-
<div align="right">
17-
<img width="25%" src="./logo/protobox-gopher.png" alt="protobox-gopher">
18-
</div>
19-
<div>
20-
<p>
21-
Protobox leverages Protocol Buffers (protobuf) to define message schemas and dispatchers through custom message options. Using Protobox's protoc-gen-go-protobox plugin alongside protobuf's protoc-gen-go plugin, you can generate type-safe message dispatchers and message structures with minimal boilerplate.
22-
</p>
23-
</div>
24-
</div>
18+
Protobox leverages Protocol Buffers (protobuf) to define message schemas and dispatchers through custom message options. Using Protobox's protoc-gen-go-protobox plugin alongside protobuf's protoc-gen-go plugin, you can generate type-safe message dispatchers and message structures with minimal boilerplate.
2519

2620
Key capabilities:
2721

@@ -31,24 +25,28 @@ Key capabilities:
3125
- Idempotent message processing with inbox pattern
3226
- Built-in support for both in-process and network message delivery
3327

34-
3528
# Background
36-
Modern distributed systems often require reliable message delivery mechanisms across various components, both within the same process and across network boundaries. While patterns like outbox and retry mechanisms are well-established solutions, implementing them repeatedly brings several challenges:
29+
30+
Modern distributed systems often require reliable message delivery mechanisms across various components, both within the same process and
31+
across network boundaries. While patterns like outbox and retry mechanisms are well-established solutions, implementing them repeatedly
32+
brings several challenges:
3733

3834
Defining and maintaining message schemas
3935
Ensuring type safety across message handlers
4036
Managing message persistence and delivery guarantees
4137
Handling both in-process and network message delivery consistently
4238
Maintaining idempotency in message processing
4339

44-
While robust messaging frameworks exist in other language ecosystems, the Go ecosystem lacked a comprehensive solution that leverages Go's strengths. Protobox addresses this gap by:
40+
While robust messaging frameworks exist in other language ecosystems, the Go ecosystem lacked a comprehensive solution that leverages Go's
41+
strengths. Protobox addresses this gap by:
4542

4643
Utilizing Protocol Buffers for schema definition and code generation
4744
Providing type-safe message handling through code generation
4845
Offering built-in support for reliable messaging patterns
4946
Embracing Go's idioms while providing high-performance implementations
5047

5148
# Features
49+
5250
## Core Features
5351

5452
- Schema-first message definition using Protocol Buffers
@@ -60,41 +58,48 @@ Embracing Go's idioms while providing high-performance implementations
6058
## Coming Soon
6159

6260
- Advanced outbox/inbox toolkit
63-
- Scalable message scheduling
64-
- Flexible message routing
65-
- Customizable storage interfaces
61+
- Scalable message scheduling
62+
- Flexible message routing
63+
- Customizable storage interfaces
6664
- Resilience patterns
67-
- Retryer
68-
- Circuit breaker
69-
- Bulkhead pattern implementation
65+
- Retryer
66+
- Circuit breaker
67+
- Bulkhead pattern implementation
7068

7169
# Prerequisites
70+
7271
- [Go](https://golang.org/dl/)
7372
- [Protocol Buffers](https://developers.google.com/protocol-buffers/docs/downloads)
7473
- [Buf(Optional)](https://docs.buf.build/installation)
7574

7675
# Installation
76+
7777
```bash
7878
go get -u github.com/notjustmoney/protobox
7979
```
8080

8181
To install the protoc plugin:
82+
8283
```bash
8384
go install github.com/notjustmoney/protoc-gen-go-protobox
8485
```
8586

8687
# Getting Started
88+
8789
Recommend to use [Buf](https://docs.buf.build/installation) for generating and managing Protobuf files.
8890

8991
For more examples, see [examples](./examples).
9092

9193
# Documentation
94+
9295
Documentation is available soon!
9396

9497
# Contributing
98+
9599
Issues, PRs for design suggestion, contributing are welcome.
96100

97101
# License
102+
98103
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
99104

100105
## Star History

0 commit comments

Comments
 (0)