# naria-brain

> A framework to facilitate building bots and other tools that require natural language processing.

Latest version **0.0.1** (published 2017-03-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install naria-brain
pnpm add naria-brain
yarn add naria-brain
bun add naria-brain
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2017-03-19 |
| First published | 2017-03-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | João Cerqueira |
| Maintainers | joaocrq |

## Links

- npm: https://www.npmjs.com/package/naria-brain
- Repository: https://github.com/outlimits/naria-brain
- Homepage: https://github.com/outlimits/naria-brain#readme
- Issues: https://github.com/outlimits/naria-brain/issues
- npm.io page: https://npm.io/package/naria-brain

## Dependencies (1)

- [natural](https://npm.io/package/natural.md) ^0.5.0

## Recent versions

- 0.0.1 (latest) — 2017-03-19

## README

naria-brain
===========

naria-brain is a framework to facilitate building bots and other tools that require natural language processing. It's build around [`natural`](https://github.com/NaturalNode/natural) an awesome natural language processing library.

**Disclaimer:** this is still a work in progress so no warranties are granted. We hope you can help identify any issues, make suggestions or even implement them!

### TABLE OF CONTENTS

* [Getting Started](#getting-started)
* [NariaBrain](#nariabrain)
* [Reactor](#reactor)
* [Examples](#examples)
* [Development](#development)

## Getting Started

You can install naria-brain with NPM or Yarn by issuing:

```
npm install naria-brain
```

or

```
yarn add naria-brain
```

Basic usage:

```javascript
import NariaBrain, {Reactor} from 'naria-brain';

// Author is a reactor that identifies questions about who developed naria-brain
// and replies with the author's name.
class Author extends Reactor {
  constructor() {
    super();

    this.train([
      {token: 'Author', text: 'who made you?'},
      {token: 'Author', text: 'who created you?'}
    ]);
  }

  react() {
    return 'A damn human from OutLimits!!';
  }
}

let brain = new NariaBrain({
  reactors: {Author}
});

console.log(brain.intercept('who made you, machine???'));
// A damn human from OutLimits!!
```

## NariaBrain

*Will be updated soon...*

## Reactor

*Will be updated soon...*

## Examples

Check [example folder](https://github.com/outlimits/naria-brain/tree/master/example) for a basic example of how to use `naria-brain`.

## Development

If you want to help out, just fork this repository and submit your PRs.

---
_Source: https://npm.io/package/naria-brain · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._