<commit_before># scramble-text-js
A library that scrambles a text and over some time gradually unscrambles it.

## Dependencies

* jQuery. Technically any version that supports creating plugins (`jQuery.fn.yournamehere = function()`).
* Uh, ES6 I think? Because I think I may have used that syntax copied from Stack Overflow

## How to use

### Quickstart
Given the following markup:

```html
<p class="scramble">Scramble mi timbers!</p>
```
In your js file, do this after you have access to jQuery:
```js
$('.scramble').scramble();
```

### Options

```js
$('.scramble').scramble({framePerReveal: 3});
```

```
framesPerReveal: how many frames it takes for the next character to be revealed / fixed. Takes a float. Lower the number, the quicker the unscramble.
```
<commit_msg>Make options in readme a table<commit_after># scramble-text-js
A library that scrambles a text and over some time gradually unscrambles it.

## Dependencies

* jQuery. Technically any version that supports creating plugins (`jQuery.fn.yournamehere = function()`).
* Uh, ES6 I think? Because I think I may have used that syntax copied from Stack Overflow

## How to use

### Quickstart
Given the following markup:

```html
<p class="scramble">Scramble mi timbers!</p>
```
In your js file, do this after you have access to jQuery:
```js
$('.scramble').scramble();
```

### Options

```js
$('.scramble').scramble({framePerReveal: 3});
```

| option name | What does it do? |
|--------- | --------- |
|`framesPerReveal`| how many frames it takes for the next character to be revealed / fixed. Takes a float. Lower the number, the quicker the unscramble.


{'fraction_non_alphanumeric': 0.13259668508287292, 'fraction_numerical': 0.0024554941682013503, 'mean_word_length': 4.326797385620915, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1580487', 'n_tokens_mistral': 527, 'n_tokens_neox': 478, 'n_words': 207}