<commit_before># Readerly

as requested by freenode@vitx

## Current tasks

- Code refactoring is being done in `source/`
- Chrome will not export `.crx` file for deployment.
- Firefox is doing whatever Firefox is doing and that needs to be fixed.

## Completed tasks

- Most files in source are already perfected except a few.
  - `source/main.js` has a lot of old code in it due to complexity.
- Rollup and Webpack work on the new code and most code has been moved to es6 modules.
- API's have been updated in `source/`
- `source/` loads in firefox.

## Development

### Prepare the code.

``` command
git clone https://github.com/Announcement/Readerly
cd Readerly

npm install
```

## Update

If you already cloned the directory do this inside of it.

``` command
git stash
git pull
```

### Compile the code

You only need to do one of these.

#### Build with the Powershell

- Windows 10

``` powershell
./script/build.ps1
```

#### Build with the Command Prompt

- Windows NT

``` cmd
script\build.bat
```

#### Build with the Unix Shell

- Linux
- BSD
- MacOS

``` sh
script/build.sh
```

#### Build with npm

- Any Operating System with Node.js installed.

``` command
npm run-script build
```
<commit_msg>simplify the readme<commit_after># Readerly

as requested by freenode@vitx

## Current tasks

- Code refactoring is being done in `source/`
- Chrome will not export `.crx` file for deployment.
- Firefox is doing whatever Firefox is doing and that needs to be fixed.

## Completed tasks

- Most files in source are already perfected except a few.
  - `source/main.js` has a lot of old code in it due to complexity.
- Rollup and Webpack work on the new code and most code has been moved to es6 modules.
- API's have been updated in `source/`
- `source/` loads in firefox.

## Development

### Prepare the code.

``` command
git clone https://github.com/Announcement/Readerly
cd Readerly

npm install
```

## Update

If you already cloned the directory do this inside of it.

``` command
git stash
git pull
```

### Compile the code

- Any Operating System with Node.js installed.

``` command
npm run-script build
```

{'fraction_non_alphanumeric': 0.09765258215962441, 'fraction_numerical': 0.002347417840375587, 'mean_word_length': 3.4675052410901466, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1231343', 'n_tokens_mistral': 683, 'n_tokens_neox': 636, 'n_words': 298}