# ferreter

> Collect anonymous usage for NPM package usage

Latest version **1.0.2** (published 2017-08-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install ferreter
pnpm add ferreter
yarn add ferreter
bun add ferreter
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2017-08-09 |
| First published | 2016-12-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | rajikaimal |
| Maintainers | rajikaimal |
| Keywords | ferreter, github |

## Links

- npm: https://www.npmjs.com/package/ferreter
- Repository: https://github.com/rajikaimal/ferreter
- Homepage: https://github.com/rajikaimal/ferreter#readme
- Issues: https://github.com/rajikaimal/ferreter/issues
- npm.io page: https://npm.io/package/ferreter

## Dependencies (5)

- [chai](https://npm.io/package/chai.md) ^3.5.0
- [nock](https://npm.io/package/nock.md) ^9.0.14
- [mocha](https://npm.io/package/mocha.md) ^3.2.0
- [request](https://npm.io/package/request.md) ^2.79.0
- [is-online](https://npm.io/package/is-online.md) ^6.0.0

## Recent versions

- 1.0.2 (latest) — 2017-08-09
- 1.0.1 — 2016-12-17
- 1.0.0 — 2016-12-17

## README

# ferreter [![Build Status](https://travis-ci.org/rajikaimal/ferreter.svg?branch=master)](https://travis-ci.org/rajikaimal/ferreter)

Collect anonymous usage for NPM package usage

## Install

```
yarn add ferreter --save-dev
```

## Usage

```js
const ferreter = require('ferreter');

ferreter('http://google.com', {'key': 'value'})
	.then((res) => {
		console.log('Done', res);
	})
	.catch((err) => {
		console.log('Something happened', err);
	});
```

## API

### ferreter(url, data)

Returns a promise

#### url

Type: `string`

URL to post usage statistics

#### data

Type: `object`

Custom object containing statistics

## License

MIT © [Rajika Imal](https://rajikaimal.github.io)

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