<commit_before># Pampoo
 A tool that replace English punctuations with Chinese ones and add spaces to format texts.

### How to use it
You can simply use the built file at `build/js/pampoo.min.js` and put it on your page:

```html
<script type="text/javascript" src="./path/to/pampoo.min.js" charset="utf-8"></script>
```

Then you will be able to clean up and formatting your text with the powerful function:
```javascript
var text = '你的一些文字some of your "best" text.可以随便写100字或者200行噢!';
var cleanedText = Pampoo.cleanUp(text);
console.log(cleanedText);
```
You will get the result in the console like:
`
你的一些文字 some of your “best” text. 可以随便写 100 字或者 200 行噢！
`

### How to contribute

If you are about to make some contribution to it, you can do `npm install` and everything will work for you then.

### Bugs to be solved
- URLs and Emails are not well treated.
- Inline code and code blocks still needs to be dealt with.

### Reference
[SmartQuotesJS](https://github.com/kellym/smartquotesjs)
[CurlyQuotes](http://alexlur.github.io/curlyquotes/)<commit_msg>Add a link to livescript version in readme<commit_after># Pampoo
 A tool that replace English punctuations with Chinese ones and add spaces to format texts.

### How to use it
You can simply use the built file at `build/js/pampoo.min.js` and put it on your page:

```html
<script type="text/javascript" src="./path/to/pampoo.min.js" charset="utf-8"></script>
```

Then you will be able to clean up and formatting your text with the powerful function:
```javascript
var text = '你的一些文字some of your "best" text.可以随便写100字或者200行噢!';
var cleanedText = Pampoo.cleanUp(text);
console.log(cleanedText);
```
You will get the result in the console like:
`
你的一些文字 some of your “best” text. 可以随便写 100 字或者 200 行噢！
`

### How to contribute

If you are about to make some contribution to it, you can do `npm install` and everything will work for you then.

### Bugs to be solved
- URLs and Emails are not well treated.
- Inline code and code blocks still needs to be dealt with.

### Other Version
[LiveScript version](https://github.com/alexlur/Pampoo/) by <NAME>

### Reference

[SmartQuotesJS](https://github.com/kellym/smartquotesjs)

[CurlyQuotes](http://alexlur.github.io/curlyquotes/)
{'fraction_non_alphanumeric': 0.10747872816838334, 'fraction_numerical': 0.011643528884908196, 'mean_word_length': 4.4754901960784315, 'pattern_counts': {'":': 0, '<': 8, '<?xml version=': 0, '>': 8, 'https://': 3, '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': '5335835', 'n_tokens_mistral': 782, 'n_tokens_neox': 744, 'n_words': 290}