<commit_before># Faceword

Faceword is a javascript module to convert image to word cloud with no external dependencies.
## How To Use
### Installation
Install the package with bower.
```sh
bower install faceword
```
Add FaceWord.js to your project
```sh
<script src="faceword/dist/FaceWord.js"></script>
```
### Using The Module
```sh
var img = image,             // Input image element
    text = 'blah blah blah', // Text to render
    canvas = '#canvas';      // Output canvas selector

FaceWord.init(img, text, canvas);
FaceWord.run();
```<commit_msg>update how to use<commit_after># Faceword

Faceword is a javascript module to convert image to word cloud with no external dependencies.
## How To Use
### Installation
Install the package with bower.
```sh
bower install faceword
```
Add FaceWord.js to your project
```sh
<script src="faceword/dist/FaceWord.js"></script>
```
### Using The Module
```sh
var img = image,             // Input image element
    text = 'blah blah blah', // Text to render
    canvas = '#canvas';      // Output canvas selector

FaceWord.run(img, text, canvas);
```
{'fraction_non_alphanumeric': 0.12556869881710647, 'fraction_numerical': 0.0, 'mean_word_length': 3.6610169491525424, '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': '2029099', 'n_tokens_mistral': 328, 'n_tokens_neox': 307, 'n_words': 130}