Skip to content

Commit 14f855a

Browse files
committed
[README] Update development docs
1 parent b7cb94e commit 14f855a

File tree

1 file changed

+8
-46
lines changed

1 file changed

+8
-46
lines changed

README.md

+8-46
Original file line numberDiff line numberDiff line change
@@ -23,54 +23,16 @@ Take a look at `examples/` for some examples of how to write clients.
2323

2424
You can read more about the Go SDK documentation on [aptos.dev](https://aptos.dev/sdks/go-sdk/)
2525

26-
## Feature support
27-
28-
- [x] BCS encoding and decoding
29-
- [x] Structured API parsing
30-
- [x] Ed25519 Signer support
31-
- [x] MultiEd25519 support
32-
- [x] Secp256k1 Signer support
33-
- [x] On-chain and off-chain multi-sig support
34-
- [x] Sponsored transaction and Multi-agent support
35-
- [x] Fungible Asset support
36-
- [x] Indexer support with limited queries
37-
- [x] Transaction submission and waiting
38-
- [x] External signer support e.g. HSMs or external services
39-
- [x] Move Package publishing support
40-
- [x] Move script support
41-
- [x] Transaction Simulation
42-
- [x] Automated sequence number management for parallel transaction submission
43-
44-
### TODO
45-
46-
- [ ] Predetermined Indexer queries for Fungible Assets and Digital Assets
47-
48-
## Examples
49-
50-
- [x] Transaction signing
51-
- [x] Fungible asset usage
52-
- [x] External and alternative signing methods
53-
- [x] On-chain multi-sig
54-
- [x] Performance differences between transaction submission methods
55-
- [x] Move package publishing support
56-
- [x] Sponsored transaction example
57-
- [x] Off-chain multi-sig example
58-
59-
### TODO
60-
61-
- [ ] Multi-agent example
62-
- [x] Script Example
63-
- [ ] Digital assets / NFTs example
64-
- [ ] Transaction parsing example (by blocks)
65-
66-
## Other TODO
67-
68-
- [x] Ensure blocks fetch all transactions associated
69-
- [ ] More testing around API parsing
70-
- [ ] TypeTag string parsing
71-
- [x] Add examples into the documentation
26+
## Development
7227

28+
1. Make your changes
29+
2. Update the CHANGELOG.md
30+
3. Run `gofumpt -l -w .`
31+
4. Run `golangci-lint run`
32+
5. Commit with a good description
33+
6. Submit a PR
7334

7435
# How to publish
36+
7537
1. Update changelog with a pull request
7638
2. Create a new tag via e.g. v1.1.0 with the list of changes

0 commit comments

Comments
 (0)