Skip to content

Commit 26ef3fd

Browse files
authored
Beautify readme & improve description (#23)
* Beautify readme & improve description * Format
1 parent 994cd29 commit 26ef3fd

File tree

2 files changed

+10
-12
lines changed

2 files changed

+10
-12
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ categories = [
44
"encoding",
55
"no-std",
66
]
7-
description = "Collection of array/bytes/hex utilities."
7+
description = "A collection of array/bytes/hex utilities."
88
edition = "2021"
99
homepage = "https://array-bytes.hack.ink"
1010
keywords = [

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<!-- ![array-bytes]() -->
55

66
# array-bytes
7-
### Collection of Array/Bytes/Hex Utilities.
7+
### A Collection of Array/Bytes/Hex Utilities.
88

99
[![License](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
1010
[![Checks](https://github.com/hack-ink/array-bytes/actions/workflows/checks.yml/badge.svg?branch=main)](https://github.com/hack-ink/array-bytes/actions/workflows/checks.yml)
@@ -16,7 +16,7 @@
1616
</div>
1717

1818
## Abilities
19-
#### `TryFromHex` Trait
19+
#### `TryFromHex` trait
2020
- Convert `Hex` to `Num`
2121
- type `&str -> isize`
2222
- type `&str -> i8`
@@ -31,11 +31,11 @@
3131
- type `&str -> u64`
3232
- type `&str -> u128`
3333

34-
#### `bytes` Prefixed Functions
34+
#### `bytes` prefixed functions
3535
- Convert `Bytes` to `Hex`
3636
- type `&[u8] -> String`
3737

38-
#### `hex` Prefixed Functions
38+
#### `hex` prefixed functions
3939
- Convert `HexBytes` to `Hex`
4040
- type `&[u8] -> &str`
4141
- e.g. `b"0x..." -> "0x..."`
@@ -47,21 +47,21 @@
4747
- type `&str -> T`
4848
- e.g. `"0x..." -> [u8; 20] -> H160`
4949

50-
#### `slice` Prefixed Functions
50+
#### `slice` prefixed functions
5151
- Build fixed length `Array` from `Slice`
5252
- type `&[T] -> [T; N]`
5353
- Transform `Slice` to `G`
5454
- type `&[T] -> G`
5555
- e.g. `&[0_u8, ...] -> [u8; 20] -> H160`
5656

57-
#### `vec` Prefixed Functions
57+
#### `vec` prefixed functions
5858
- Build fixed length `Array` from `Vec`
5959
- type `Vec<T> -> [T; N]`
6060
- Transform `Vec` to `G`
6161
- type `Vec<T> -> G`
6262
- e.g. `vec![0_u8, ...] -> [u8; 20] -> H160`
6363

64-
#### Serde Support (require feature `serde`)
64+
#### Serde support (require feature `serde`)
6565
- `#[serde(deserialize_with = "array_bytes::hex_deserialize_n_into")]`
6666
- type `S -> T`
6767
- e.g. `"0x..." -> H160`
@@ -72,10 +72,8 @@
7272
- type `S -> Vec<u8>`
7373
- e.g. `"0x00" -> vec![0_u8]`
7474

75-
## Benchmark Results
76-
<div align="right">
77-
<sub>Friday, September 9, 2022</sub>
78-
</div>
75+
## Benchmark results
76+
<div align="right"><sub>Friday, September 9, 2022</sub></div>
7977

8078
```rs
8179
array_bytes::bytes2hex time: [37.577 µs 37.755 µs 37.914 µs]

0 commit comments

Comments
 (0)