Projects Resume
Fork me on GitHub

Build Status

Produces a simple, valid humans.txt to be parsed by web crawlers. Adheres to the specification provided by Humanstxt.org. Requires Node 4+. Installed through NPM with:

npm install humans-generator --save-dev

Simply require the module and execute it with an optional array of configuration.

  • Team: A string or array of shoutouts to your squad.
  • Thanks: A string or array of people you’d like to thank.
  • Site: A string or array of technical specifications about your site.
  • Note: A string or array of things you’d like to mention.
var humans = require('humans-generator');

humans({
    team: 'Hayden Bleasel (@haydenbleasel on Twitter)',
    thanks: [
        'Node (@nodejs on Twitter)',
        'Gulp (@gulpjs on Twitter)'
    ],
    site: [
        'Standards: HTML5, CSS3',
        'Components: jQuery, Normalize.css',
        'Software: Atom'
    ],
    note: 'Built with love by Hayden Bleasel.'
}, function (error, humans) {
    // Join ('\n') and write this to a file
    console.log(error, humans);
});

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

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

Outputs the following file:

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


/* TEAM */
Hayden Bleasel (@haydenbleasel on Twitter)

/* THANKS */
Node (@nodejs on Twitter)
Gulp (@gulpjs on Twitter)

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

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

To build the ES5 version:

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