<commit_before>Placard-API
===========

A simple [placard](https://www.jogossantacasa.pt/web/Placard) API client library for node.js

## Installation

```bash
$ npm install placard-api
```

## Example

```javascript
const placard = require('placard-api');

placard.nextEvents((err, data)=> {
    console.log(data)
})

// or

placard.nextEvents().then((data)=> {
    console.log(data)
})
```<commit_msg>add badges and improve description<commit_after>Placard-API
===========

A simple [placard](https://www.jogossantacasa.pt/web/Placard) API client library for [node.js](http://nodejs.org).

[![npm version](https://badge.fury.io/js/placard-api.svg)](https://www.npmjs.com/package/placard-api)
[![Build Status](https://travis-ci.org/efernandesng/placard-api.svg?branch=master)](https://travis-ci.org/efernandesng/placard-api)


## Installation

```bash
$ npm install placard-api
```

## Example

```javascript
const placard = require('placard-api');

placard.nextEvents((err, data)=> {
    console.log(data)
})

// or

placard.nextEvents().then((data)=> {
    console.log(data)
})
```
{'fraction_non_alphanumeric': 0.20960295475530932, 'fraction_numerical': 0.0, 'mean_word_length': 4.923497267759563, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 7, 'https://': 6, 'lorem ipsum': 0, 'www.': 3, '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': '1706811', 'n_tokens_mistral': 414, 'n_tokens_neox': 393, 'n_words': 58}