Skip to content

Commit 811fde2

Browse files
authored
Merge pull request #24 from sibevin/stag-2024.10.13.001
Release v2.0.3
2 parents 0cd2cd5 + de9aaac commit 811fde2

File tree

4 files changed

+222
-207
lines changed

4 files changed

+222
-207
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
A simple way to generate a random token.
99

10-
## Usage
10+
# Usage
1111

1212
Import package first
1313

@@ -28,9 +28,9 @@ Or just simplify as:
2828
RandomToken.gen({ length: 32, seed: 'a', casing: 'u', mask: 'ABC', friendly: true })
2929
// DNJERZGWGJQTFYGYWGHAZEBGBRQFPHPF
3030

31-
## Options
31+
# Options
3232

33-
### Seed
33+
## Seed
3434

3535
Use `seed` option to customize the random characters. Here are available options:
3636

@@ -64,7 +64,7 @@ Use a string to customize random seeds.
6464
RandomToken.gen({ length: 32, seed: 'abc' })
6565
// bcabcbbcaaabcccabaabcacbcbbabbac
6666

67-
### Casing
67+
## Casing
6868

6969
Use `casing` option to modify the token case. Here are available options:
7070

@@ -88,14 +88,14 @@ Casing is not supported with following `seed` options: `'number'`, `'binary'`, `
8888
RandomToken.genf({ length: 32, seed: 'number', casing: 'l' })
8989
// Error: Invalid Parameters: casing. The casing is not supported with number seeds
9090

91-
### Mask
91+
## Mask
9292

9393
Use `mask` option to filter characters which you don't want to appear on the generated token.
9494

9595
RandomToken.gen({ length: 32, mask: '123abcABC' })
9696
// vhZp88dKzRZGxfQHqfx7DOL8jKTkWUuO
9797

98-
### Friendly
98+
## Friendly
9999

100100
Use `friendly` option to remove the ambiguous characters, the default mask includes _1, I, l, i, 0, O, o, Q, D, C, c, G, 9, 6, U, u, V, v, E, F, M, N, 8, B_.
101101

@@ -112,14 +112,20 @@ Note that the friendly option is supported with alphabet or random-generated see
112112
RandomToken.genf({ length: 32, seed: 'abc' })
113113
// Error: Invalid Parameters: friendly. The friendly mask is supported with alphabet or random-generated seeds (no "seed" is given) only.
114114

115-
## Test
115+
# Test
116116

117117
npm run test
118118

119-
## Authors
119+
# Support
120120

121-
Sibevin Wang
121+
Support the continuous development of the project with concrete actions. Any form of help means a lot to us.
122122

123-
## Copyright
123+
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/kaitwang)
124124

125-
Copyright (c) 2019-2024 Sibevin Wang. Released under the MIT license.
125+
# Authors
126+
127+
Kait Wang
128+
129+
# Copyright
130+
131+
Copyright (c) 2019-2024 Kait Wang. Released under the MIT license.

0 commit comments

Comments
 (0)