Skip to content

Commit

Permalink
fix(mock): force pkg alignment
Browse files Browse the repository at this point in the history
  • Loading branch information
exbotanical committed Oct 5, 2020
1 parent 8af819e commit 0a98084
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,42 @@
- [Installation + Usage](#usage)

## <a name="intro"></a> Introduction
X-Clacks-Middleware is an Express.js middleware package that adds the `x-clacks-overhead` header to your server responses. Simply register this middleware in your Express server, and [add your site](https://xclacksoverhead.org/dearheart/review) to the registry of those that "carry the signal"!

What is `X-Clacks-Overhead`?

From [the X-Clacks-Overhead website](https://xclacksoverhead.org/home/about):
"X-Clacks-Overhead is a non-standardised HTTP header based upon the fictional work of the late, great, Sir Terry Pratchett.

In Terry Pratchett's science-fantasy Discworld series, "The Clacks" is a network infrastructure of Semaphore Towers, that operate in a similar fashion to telegraph - named "Clacks" because of the clicking sound the system makes as signals send.

In Sir Terry's novel "Going Postal"...the inventor of the Clacks...lost his only son...and in order to keep the memory of his son alive, he transmitted his son's name as a special operational signal through the Clacks to forever preserve his memory."


### <a name="feat"></a> Features
[!screenshot](https://github.com/MatthewZito/x-clacks-middleware/tree/master/documentation/header.png)

- zero dependencies
- plug n' play
- randomizes the header values with one of any number of names

## <a name="usage"></a> Installation and Usage

Install the package in your repository:
```
npm i x-clacks-middleware
```

Register the middleware in your Express app. The default header value is 'Terry Pratchett'. You may elect to use the middleware option `names` to add one or multiple names to commemorate.
```
app.use(setXClacksOverheadHeader({
names: [
"Yukio Mishima",
"Hermann Hesse",
"John Conway"
]
})
);
```

Options is an object with a `names` property, an Array of one or more strings. The header will randomly select one of the names for each response (assuming you've provided more than one name, of course) and prepend it with the `GNU` prefix, per the `x-clacks-overhead` standard.
Binary file added documentation/header.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file removed documentation/usage.md
Empty file.

0 comments on commit 0a98084

Please sign in to comment.