Skip to content

Commit 494af0f

Browse files
committed
update readme according to template
1 parent 8d6e7c4 commit 494af0f

File tree

1 file changed

+33
-6
lines changed

1 file changed

+33
-6
lines changed

README.md

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
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
# pytempo
217

3-
>[!IMPORTANT]
18+
> [!IMPORTANT]
419
> This is a **proof-of-concept**, please reach out to the Tempo team if you are interested in using this library in production.
520
621
Web3.py extension for Tempo.
@@ -12,6 +27,7 @@ pip install -e .
1227
```
1328

1429
Or with uv:
30+
1531
```bash
1632
uv add .
1733
```
@@ -160,6 +176,7 @@ Monkey patches web3.py to recognize Tempo AA transactions. **Must be called befo
160176
Creates a Tempo AA transaction.
161177

162178
**Parameters:**
179+
163180
- `to` (str): Destination address
164181
- `value` (int): Value in wei (default: 0)
165182
- `gas` (int): Gas limit
@@ -181,6 +198,7 @@ Creates a Tempo AA transaction.
181198
Main transaction class.
182199

183200
**Methods:**
201+
184202
- `sign(private_key, for_fee_payer=False)` - Sign the transaction
185203
- `encode()` - Encode to bytes for transmission
186204
- `hash()` - Get transaction hash
@@ -190,15 +208,24 @@ Main transaction class.
190208
## Examples
191209

192210
See the `examples/` directory:
211+
193212
- `simple_send.py` - Simple value transfer
194213
- `basic_transaction.py` - Transaction with fee token
195214
- `fee_payer_sponsored.py` - Gas sponsorship and call batching
196215

197-
## License
216+
## Contributing
217+
218+
Our contributor guidelines can be found in [`CONTRIBUTING.md`](https://github.com/tempoxyz/tempo?tab=contributing-ov-file).
198219

199-
Licensed under either of:
220+
## Security
221+
222+
See [`SECURITY.md`](https://github.com/tempoxyz/pytempo?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.
223+
224+
## License
200225

201-
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
202-
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
226+
Licensed under either of [Apache License](./LICENSE-APACHE), Version
227+
2.0 or [MIT License](./LICENSE-MIT) at your option.
203228

204-
at your option.
229+
Unless you explicitly state otherwise, any contribution intentionally submitted
230+
for inclusion in these crates by you, as defined in the Apache-2.0 license,
231+
shall be dual licensed as above, without any additional terms or conditions.

0 commit comments

Comments
 (0)