Skip to content

Commit b581535

Browse files
committed
📖 update Documentation and doctoc
1 parent 8a39158 commit b581535

File tree

2 files changed

+17
-6
lines changed

2 files changed

+17
-6
lines changed

Documentation/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
1+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
2+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3+
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
4+
5+
- [Design Decisions](#design-decisions)
6+
- [Core features:](#core-features)
7+
- [FAQ](#faq)
8+
9+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
10+
111
## Design Decisions
212

313
- Functionality was focused on serializing and **signing transactions locally** on the device to **send raw transactions** to the Ethereum network
414
- **Requirements for password input** on every transaction are indeed a design decision. Interface designers can save user passwords with the user's consent
515
- Public function for **private key export** is exposed for user convenience but marked as `UNSAFE_`. Typical workflow takes care of EIP155 compatibility and proper clearing of private key data from memory
616

717

8-
### Core features:
18+
## Core features:
919

1020
- [x] Swift implementation of [web3.js](https://github.com/ethereum/web3.js/) functionality :zap:
1121
- [x] Interaction with remote node via **JSON RPC** :thought_balloon:

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,19 @@
1717
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
1818

1919

20-
- [Design Decisions](#design-decisions)
21-
- [Projects that using web3swift](#projects-that-using-web3swift)
2220
- [Installation](#installation)
2321
- [Requirements](#requirements)
2422
- [Migration Guides](#migration-guides)
2523
- [Documentation](#documentation)
2624
- [Examples](#examples)
25+
- [Web3View example](#web3view-example)
2726
- [FAQ](#faq)
28-
- [Credits](#credits)
29-
- [What we have already done](#what-we-have-already-done)
30-
- [Future steps](#future-steps)
27+
- [Core features:](#core-features)
28+
- [Projects that are using web3swift](#projects-that-are-using-web3swift)
29+
- [Support](#support)
3130
- [Contribute](#contribute)
31+
- [Future steps](#future-steps)
32+
- [Credits](#credits)
3233
- [Security Disclosure](#security-disclosure)
3334
- [License](#license)
3435

0 commit comments

Comments
 (0)