<commit_before># Cleantalk Nodejs API

Nodejs API for antispam service [cleantalk.org](https://cleantalk.org). Invisible protection from spam, no captches, no puzzles, no animals and no math.

## Contents
- [Install]
- [Use]
- [API]

### Contributors
- [<NAME>](https://github.com/westtrade)

# Install

# Use

# API<commit_msg>Add main doc. Install.<commit_after># Cleantalk Nodejs API

Nodejs API for antispam service [cleantalk.org](https://cleantalk.org). Invisible protection from spam, no captches, no puzzles, no animals and no math.

## Contents
- [Requirements]()
- [Install]()
- [Use]()
- [API]()

### Contributors
- [westtrade](https://github.com/westtrade)
- [ChivPoint](https://github.com/ChivPoint)

# Requirements
- node.js
- npm or yarn
- node-gyp
- python 2.7

## install [node.js]( https://nodejs.org/en/download/)

## install/update [npm]( https://nodejs.org/en/download/) or [yarn](https://yarnpkg.com/en/docs/install) 
```sh
npm update npm -g
```

```sh
npm update npm -g
```
# Install

## yarn
```sh
yarn add cleantalk
```

## npm
```sh
npm install cleantalk
```

# Use

# API
{'fraction_non_alphanumeric': 0.17486338797814208, 'fraction_numerical': 0.0018214936247723133, 'mean_word_length': 3.9954545454545456, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 8, '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': '3559367', 'n_tokens_mistral': 422, 'n_tokens_neox': 391, 'n_words': 104}