Skip to content
This repository has been archived by the owner on Jun 6, 2024. It is now read-only.

Commit

Permalink
Merge pull request #20 from schoenbergerb/update-docs-and-version
Browse files Browse the repository at this point in the history
update docs
  • Loading branch information
schoenbergerb authored Jul 28, 2022
2 parents 7e05a8c + 503b8b3 commit f11576c
Showing 1 changed file with 16 additions and 19 deletions.
35 changes: 16 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,38 +94,35 @@ const b64 = font.toString(`base64`)

# Options

<br />

### strength
## strength

> obfuscation strength multiplier ( default: 1 ) <br />
> all under 0.1 makes no sense ( paths can be simply back calculated ) <br />
> all over 10 makes no sense ( looks like 💩 )
##### obfuscation strength multiplier ( default: 1 )
##### all under 0.1 makes no sense ( paths can be simply back calculated )
##### all over 10 makes no sense ( looks like 💩 )

<img src="./docs/obfuscationstrength.jpg">

<br />
<br />

### characterRange
## characterRange

> [character range](https://www.ling.upenn.edu/courses/Spring_2003/ling538/UnicodeRanges.html) used for encryption
##### [character range](https://www.ling.upenn.edu/courses/Spring_2003/ling538/UnicodeRanges.html) used for encryption

> - PRIVATE_USE_AREA &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ___DEFAULT___
> - LATIN
> - GREEK
> - CYRILLIC
> - HIRAGANA
> - KATAKANA
###### PRIVATE_USE_AREA &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ___DEFAULT___
###### LATIN
###### GREEK
###### CYRILLIC
###### HIRAGANA
###### KATAKANA

<br />

### lowMemory
## lowMemory

##### use only if you do not have a lot of memory and noscrape cannot load the given font file


> DEFAULT: **false**
###### DEFAULT: **false**
> use only if you do not have a lot of memory and noscrape cannot load the given font file

<br />
<br />
Expand Down

0 comments on commit f11576c

Please sign in to comment.