1.0.1 • Published 6 years ago

comico v1.0.1

Weekly downloads
-
License
ISC
Repository
-
Last release
6 years ago

Comico

If your users encounter a 404, lift their spirits by showing them a joke on the erro page. They might not like the error, but they'll love your product.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Make sure you have node in order to install this package.

Installing

Install the package:

npm install comico

Import the package to your project:

const Comico = require("comico");

Now you can set the categories of jokes you would like to use. The catogories include: dad, stories, one liners. You set the categories using an array like this:

Comico.setCategories(['dad','stories']);

In that case I wanted to exclude one liners.

Now I can get display a random joke like this:

console.log( Comico.randomeJoke() )

Style it as you wish and place it on your 404 page or wherever you see fit. Enjoy!

License

This project is licensed under the MIT License - see the LICENSE.md file for details