Skip to content

Commit

Permalink
Add improved docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Nov 6, 2022
1 parent aa4afaf commit 061093f
Showing 1 changed file with 79 additions and 14 deletions.
93 changes: 79 additions & 14 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,54 @@

List of, *like*, English (both British and American) filler words.

## Install
## Contents

* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`fillers`](#fillers-1)
* [Data](#data)
* [Types](#types)
* [Compatibility](#compatibility)
* [Related](#related)
* [Contribute](#contribute)
* [Security](#security)
* [License](#license)

## What is this?

This package exposes a list of pretty useless words, which are typically used
to fill empty space.

This package is ESM only: Node 12+ is needed to use it and it must be `import`ed
instead of `require`d.
## When should I use this?

Use this when you want to do fun things with natural language.

## Install

[npm][]:
This package is [ESM only][esm].
In Node.js (version 14.14+, 16.0+), install with [npm][]:

```sh
npm install fillers
```

In Deno with [`esm.sh`][esmsh]:

```js
import {fillers} from 'https://esm.sh/fillers@2'
```

In browsers with [`esm.sh`][esmsh]:

```html
<script type="module">
import {fillers} from 'https://esm.sh/fillers@2?bundle'
</script>
```

## Use

```js
Expand Down Expand Up @@ -45,35 +82,55 @@ Yields:

## API

This package exports the following identifiers: `fillers`.
This package exports the identifier `fillers`.
There is no default export.

### `fillers`

*So*, `fillers` exposes a list of strings (`Array.<string>`).
*So*, `fillers` exposes a list of strings (`Array<string>`).

## Support
## Data

For a complete list of supported filler words and phrases, *like*, see
[`index.js`][data].

Note that the words listed in **fillers** *might* or, in fact, *might* not be
Note that the words listed in `fillers` *might* or, in fact, *might* not be
fillers.

## Types

This package is fully typed with [TypeScript][].
It exports no additional types.

## Compatibility

This package is at least compatible with all maintained versions of Node.js.
As of now, that is Node.js 14.14+ and 16.0+.
It also works in Deno and modern browsers.

## Related

* [`buzzwords`](https://github.com/words/buzzwords)
List of buzzwords
list of buzzwords
* [`dale-chall`](https://github.com/words/dale-chall)
List of familiar American-English words (1995)
list of familiar American-English words (1995)
* [`hedges`](https://github.com/words/hedges)
List of hedge words
list of hedge words
* [`profanities`](https://github.com/words/profanities)
List of profane words
list of profane words
* [`spache`](https://github.com/words/spache)
List of simple American-English words (1974)
list of simple American-English words (1974)
* [`weasels`](https://github.com/words/weasels)
— List of weasel words
— list of weasel words

## Contribute

Yes please!
See [How to Contribute to Open Source][contribute].

## Security

This package is safe.

## License

Expand All @@ -99,6 +156,14 @@ fillers.

[npm]: https://docs.npmjs.com/cli/install

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[esmsh]: https://esm.sh

[typescript]: https://www.typescriptlang.org

[contribute]: https://opensource.guide/how-to-contribute/

[license]: license

[author]: https://wooorm.com
Expand Down

0 comments on commit 061093f

Please sign in to comment.