express-humans

express-humans

Express middleware for generating a humans.txt or responding with an existing file.

Usage

First run npm install express-humans, then :

const humans = require('express-humans');
const express = require('express');

const app = express();

app.use(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.'
}));

app.listen(3000);

or :

// Using the path of the humans.txt file
app.use(humans('./humans.txt'));

API

humans(options)

• options : String or Object
  • if String : the path of the humans.txt file to serve
  • if Object : the humans-generator package config

Development

npm run build # Or "yarn run build"
npm test # Or "yarn test"

Credits

Inspired of express-robots.

Changelog

1.0.2 (Sep. 5th 2017)

Minor fixes :

• Dependencies upgrade
• Typo fix in README