<commit_before>![Logo](unifi.png)
# node-unifi

[![Build](https://travis-ci.org/jens-maus/node-unifi.svg?branch=master)](https://travis-ci.org/jens-maus/node-unifi)
[![NPM version](http://img.shields.io/npm/v/node-unifi.svg)](https://www.npmjs.com/package/node-unifi)
[![Downloads](https://img.shields.io/npm/dm/node-unifi.svg)](https://www.npmjs.com/package/node-unifi)
[![License](https://img.shields.io/github/license/jens-maus/node-unifi.svg)](https://github.com/jens-maus/node-unifi/blob/master/LICENSE)
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RAQSDY9YNZVCL)
[![GitHub stars](https://img.shields.io/github/stars/jens-maus/node-unifi.svg?style=social&label=Star)](https://github.com/jens-maus/node-unifi/stargazers/)

[![NPM](https://nodei.co/npm/node-unifi.png?downloads=true)](https://nodei.co/npm/node-unifi/) [![Greenkeeper badge](https://badges.greenkeeper.io/mabunixda/node-unifi.svg)](https://greenkeeper.io/)

Node-UniFi is a NodeJS module that allows to query/control [UniFi devices](http://www.ubnt.com/) via the official UniFi-Controller API. It is developed to be compatible to the latest UniFi-Controller API version starting with v4.x.x/v5.x.x.

## Features
* Supports all UniFi-Controller API features introduced with v4.x.x and v5.x.x.
* Returns all data in JSON parsable strings/objects.

## Requirements
* Installed [UniFi-Controller](https://www.ubnt.com/download/unifi) version v4 or v5
* Working UniFi-device environment

## Installation
node-unifi can be installed using the following npm command:

```sh
npm install node-unifi
```

## Example<commit_msg>repositioned greenkeeper badge<commit_after>![Logo](unifi.png)
# node-unifi

[![Build](https://travis-ci.org/jens-maus/node-unifi.svg?branch=master)](https://travis-ci.org/jens-maus/node-unifi)
[![NPM version](http://img.shields.io/npm/v/node-unifi.svg)](https://www.npmjs.com/package/node-unifi)
[![Downloads](https://img.shields.io/npm/dm/node-unifi.svg)](https://www.npmjs.com/package/node-unifi)
[![License](https://img.shields.io/github/license/jens-maus/node-unifi.svg)](https://github.com/jens-maus/node-unifi/blob/master/LICENSE)
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RAQSDY9YNZVCL)
[![Greenkeeper badge](https://badges.greenkeeper.io/mabunixda/node-unifi.svg)](https://greenkeeper.io/)

[![GitHub stars](https://img.shields.io/github/stars/jens-maus/node-unifi.svg?style=social&label=Star)](https://github.com/jens-maus/node-unifi/stargazers/)

[![NPM](https://nodei.co/npm/node-unifi.png?downloads=true)](https://nodei.co/npm/node-unifi/)

Node-UniFi is a NodeJS module that allows to query/control [UniFi devices](http://www.ubnt.com/) via the official UniFi-Controller API. It is developed to be compatible to the latest UniFi-Controller API version starting with v4.x.x/v5.x.x.

## Features
* Supports all UniFi-Controller API features introduced with v4.x.x and v5.x.x.
* Returns all data in JSON parsable strings/objects.

## Requirements
* Installed [UniFi-Controller](https://www.ubnt.com/download/unifi) version v4 or v5
* Working UniFi-device environment

## Installation
node-unifi can be installed using the following npm command:

```sh
npm install node-unifi
```

## Example
{'fraction_non_alphanumeric': 0.18219584569732938, 'fraction_numerical': 0.004154302670623145, 'mean_word_length': 5.129090909090909, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 32, 'lorem ipsum': 0, 'www.': 10, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2028007', 'n_tokens_mistral': 1315, 'n_tokens_neox': 1249, 'n_words': 175}