Skip to content

Commit bd5a97b

Browse files
committed
refactor(#29): readme updates
1 parent b436eb7 commit bd5a97b

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ An implementation of the W3C Web Cryptography API specification (https://www.w3.
1717
- [Parameter Definitions](#parameter-definitions)
1818
- [Examples](#examples)
1919
- [HMAC](#hmac)
20+
- [Parameter Definitions](#parameter-definitions-1)
21+
- [Examples](#examples-1)
2022
- [RSA-OAEP](#rsa-oaep)
2123
- [SHA](#sha)
2224
- [Contributing](#contributing)
@@ -61,7 +63,9 @@ See specific algorithms for the parameter types to be passed in.
6163

6264
### ECDSA
6365

64-
The **ECDSA** algorithm is the implementation of operations described in [§23](https://www.w3.org/TR/WebCryptoAPI/#ecdsa) of the W3C specification. You can import it into your program with `import "github.com/armortal/webcrypto-go/algorithms/ecdsa"`.
66+
The **ECDSA** algorithm is the implementation of operations described in [§23](https://www.w3.org/TR/WebCryptoAPI/#ecdsa) of the W3C specification.
67+
68+
`import "github.com/armortal/webcrypto-go/algorithms/ecdsa"`.
6569

6670
#### Parameter Definitions
6771

@@ -176,7 +180,9 @@ func main() {
176180

177181
### HMAC
178182

179-
The **HMAC** algorithm is the implementation of operations described in [§29](https://www.w3.org/TR/WebCryptoAPI/#hmac) of the W3C specification. You can import it into your program with `import "github.com/armortal/webcrypto-go/algorithms/hmac"`.
183+
The **HMAC** algorithm is the implementation of operations described in [§29](https://www.w3.org/TR/WebCryptoAPI/#hmac) of the W3C specification.
184+
185+
`import "github.com/armortal/webcrypto-go/algorithms/hmac"`.
180186

181187
#### Parameter Definitions
182188

@@ -192,7 +198,7 @@ As specified in [§29.5](https://www.w3.org/TR/WebCryptoAPI/#hmac-keygen-params)
192198
| Hash | `string` | The inner hash function to use. See the supported [hash algorithms](#hash-algorithms). |
193199
| Length | `uint64` | The length (in bits) of the key to generate. If unspecified, the recommended length will be used, which is the size of the associated hash function's block size. |
194200

195-
###### ImportParams
201+
##### ImportParams
196202

197203
As specified in [§29.3](https://www.w3.org/TR/WebCryptoAPI/#hmac-importparams)
198204

0 commit comments

Comments
 (0)