@lwys-pkg-releaser/node-bullshit-generator/README.md

Port of menzi11/BullshitGenerator@github.com to JavaScript

# node-bullshit-generator

[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/Dobby233Liu/node-bullshit-generator) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

A Node.js library/program that generates meaningless Chinese bullshit.

Basically, it's http://github.com/menzi11/BullshitGenerator but for Node.js.

## Installation

Through `npm`:

```bash
npm install @lwys-pkg-releaser/node-bullshit-generator
```

## Documentation

A very basic and **unfinished** documentation is in the [docs folder](docs), which is also hosted on [Read The Docs](https://node-bullshit-generator.readthedocs.io/). **Due of the document's unfinished nature, please be very careful while using it.**

## (Chinese) web page demo

A demo can be found at: https://Dobby233Liu.github.io/node-bullshit-generator

**Note:** This demo is not actively maintained.

## License

This program is licensed under the Anti 996 License, version 1.0 (draft). See [LICENSE](LICENSE) or [LICENSE_CN](LICENSE_CN). For license notices for dict data, see [Included Dictionaries](docs/packeddicts.md) in the documentation.