# humans-generator

> Humans.txt generator for Node.js

Latest version **2.1.1** (published 2017-06-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install humans-generator
pnpm add humans-generator
yarn add humans-generator
bun add humans-generator
```

## 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 | 2.1.1 |
| Published | 2017-06-03 |
| First published | 2014-06-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 20 |
| Author | Hayden Bleasel |
| Maintainers | alexistm |
| Keywords | humans, txt, generator, node, gulpfriendly, gulpplugin |

## Links

- npm: https://www.npmjs.com/package/humans-generator
- Repository: https://github.com/AlexisTM/humans-generator
- Issues: https://github.com/AlexisTM/humans-generator/issues
- npm.io page: https://npm.io/package/humans-generator

## Dependencies (6)

- [async](https://npm.io/package/async.md) *
- [vinyl](https://npm.io/package/vinyl.md) *
- [figlet](https://npm.io/package/figlet.md) *
- [cheerio](https://npm.io/package/cheerio.md) *
- [through2](https://npm.io/package/through2.md) *
- [underscore](https://npm.io/package/underscore.md) *

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 2.1.1 (latest) — 2017-06-03
- 2.1.0 — 2017-05-27
- 2.0.4 — 2017-05-22
- 2.0.3 — 2016-07-26
- 2.0.2 — 2015-11-28
- 2.0.1 — 2015-11-24
- 2.0.0 — 2015-11-22
- 1.3.0 — 2015-11-18
- 1.2.9 — 2015-11-11
- 1.2.8 — 2015-10-29
- 1.2.7 — 2015-01-14
- 1.2.6 — 2014-11-16
- 1.2.5 — 2014-11-16
- 1.2.4 — 2014-11-15
- 1.2.3 — 2014-11-15
- … 15 more at https://npm.io/package/humans-generator/versions

## README

# Humans Generator [![Build Status](https://travis-ci.org/AlexisTM/humans-generator.svg?branch=master)](https://travis-ci.org/AlexisTM/humans-generator)

Produces a simple, valid humans.txt to be parsed by web crawlers. Adheres to the [specification](http://humanstxt.org/Standard.html) provided by Humanstxt.org. Requires Node 4+. Installed through NPM with:

```shell
npm install humans-generator --save-dev
```

Simply require the module and execute it with some configuration. It can take for each information a String, an Array, an Object or any combinaison of the 3.

The standard propose your those fields:

- header: The ASCII art, default is Humans.txt 
- Team: Shoutouts to your squad.
- Thanks: People you'd like to thank.
- Site: Technical specifications about your site.
- Note: Things you'd like to mention.

```javascript
var humans = require('humans-generator');

humans({
        team: [{
                    "Original developer": "Hayden Bleasel",
                    Twitter: "@haydenbleasel" 
                },
                {
                    Maintainer: "Alexis Paques",
                    Github: "@AlexisTM"
                }],
        thanks: [
            'Node',
            'Gulp'
        ],
        site:
            {
                'Standards': 'HTML5, CSS3',
                'Components': 'jQuery, Normalize.css',
                'Softwares': 'Atom, SublimeText'
            },
        note: 'Built with love by Hayden Bleasel.'
    
    }, function (error, humans) {
    if(error)  console.log(error);
    else console.log(humans.join('\n'));
});
```

Outputs the following file:

```
  _   _                                  _        _   
 | | | |_   _ _ __ ___   __ _ _ __  ___ | |___  _| |_ 
 | |_| | | | | '_ ` _ \ / _` | '_ \/ __|| __\ \/ / __|
 |  _  | |_| | | | | | | (_| | | | \__ \| |_ >  <| |_ 
 |_| |_|\__,_|_| |_| |_|\__,_|_| |_|___(_)__/_/\_\\__|
                                                      

/* TEAM */
Original developer: Hayden Bleasel
Twitter: @haydenbleasel

Maintainer: Alexis Paques
Github: @AlexisTM

/* THANKS */
Node
Gulp

/* SITE */
Standards: HTML5, CSS3
Components: jQuery, Normalize.css
Softwares: Atom, SublimeText

/* NOTE */
Built with love by Hayden Bleasel.

```

If you need an ES5 build for legacy purposes, just require the ES5 file:

```javascript
var humans = require('humans-generator/es5');
```

To build the ES5 version:

```sh
npm install -g babel-cli
babel --presets es2015 index.js --out-file es5.js
```

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