Skip to content

Commit 2b1f60e

Browse files
authored
Merge pull request #2 from tempoxyz/zerosnacks/update-readme
fix: update README w/ template
2 parents 805f07a + abd088e commit 2b1f60e

File tree

1 file changed

+43
-11
lines changed

1 file changed

+43
-11
lines changed

README.md

Lines changed: 43 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,31 @@
1+
<br>
2+
<br>
3+
4+
<p align="center">
5+
<a href="https://tempo.xyz">
6+
<picture>
7+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/tempoxyz/.github/refs/heads/main/assets/combomark-dark.svg">
8+
<img alt="tempo combomark" src="https://raw.githubusercontent.com/tempoxyz/.github/refs/heads/main/assets/combomark-bright.svg" width="auto" height="120">
9+
</picture>
10+
</a>
11+
</p>
12+
13+
<br>
14+
<br>
15+
116
# tempo-go
217

318
Go SDK for building applications on [Tempo](https://tempo.xyz)
419

520
**Contents**
21+
622
- [Installation](#installation)
723
- [Quick Start](#quick-start)
824
- [Example Usage](#example-usage)
925
- [Packages](#packages)
1026
- [Testing](#testing)
1127
- [Development Setup](#development-setup)
1228

13-
1429
## Installation
1530

1631
```bash
@@ -71,11 +86,11 @@ func buildERC20TransferData(to common.Address, amount *big.Int) []byte {
7186

7287
## Example Usage
7388

74-
| Use Case | Example |
75-
|----------|---------|
76-
| **Basic Transfer** | [examples/simple-send](examples/simple-send) |
77-
| **Fee Sponsorship** | [examples/feepayer](examples/feepayer) |
78-
| **Batch Calls** | See [transaction tests](pkg/transaction/transaction_test.go) |
89+
| Use Case | Example |
90+
| ------------------- | ------------------------------------------------------------ |
91+
| **Basic Transfer** | [examples/simple-send](examples/simple-send) |
92+
| **Fee Sponsorship** | [examples/feepayer](examples/feepayer) |
93+
| **Batch Calls** | See [transaction tests](pkg/transaction/transaction_test.go) |
7994

8095
### Basic Transfer
8196

@@ -134,11 +149,11 @@ client.SendTransaction(tx)
134149

135150
## Packages
136151

137-
| Package | Description | Documentation |
138-
|---------|-------------|---------------|
139-
| `transaction` | TempoTransaction encoding, signing, and validation | [README](pkg/transaction/README.md) |
140-
| `client` | RPC client for interacting with Tempo nodes | [GoDoc](https://pkg.go.dev/github.com/tempoxyz/tempo-go/pkg/client) |
141-
| `signer` | Key management and signature generation | [GoDoc](https://pkg.go.dev/github.com/tempoxyz/tempo-go/pkg/signer) |
152+
| Package | Description | Documentation |
153+
| ------------- | -------------------------------------------------- | ------------------------------------------------------------------- |
154+
| `transaction` | TempoTransaction encoding, signing, and validation | [README](pkg/transaction/README.md) |
155+
| `client` | RPC client for interacting with Tempo nodes | [GoDoc](https://pkg.go.dev/github.com/tempoxyz/tempo-go/pkg/client) |
156+
| `signer` | Key management and signature generation | [GoDoc](https://pkg.go.dev/github.com/tempoxyz/tempo-go/pkg/signer) |
142157

143158
## Testing
144159

@@ -224,3 +239,20 @@ make build_examples
224239
```bash
225240
make fix
226241
```
242+
243+
## Contributing
244+
245+
Our contributor guidelines can be found in [`CONTRIBUTING.md`](https://github.com/tempoxyz/tempo?tab=contributing-ov-file).
246+
247+
## Security
248+
249+
See [`SECURITY.md`](https://github.com/tempoxyz/tempo-go?tab=security-ov-file). Note: Tempo is still undergoing audit and does not have an active bug bounty. Submissions will not be eligible for a bounty until audits have concluded.
250+
251+
## License
252+
253+
Licensed under either of [Apache License](./LICENSE-APACHE), Version
254+
2.0 or [MIT License](./LICENSE-MIT) at your option.
255+
256+
Unless you explicitly state otherwise, any contribution intentionally submitted
257+
for inclusion in these crates by you, as defined in the Apache-2.0 license,
258+
shall be dual licensed as above, without any additional terms or conditions.

0 commit comments

Comments
 (0)