disco-images/README.md

A powerful tool to generate anime images/gifs

<!-- # Setting Up

First you'll need to install `disco-images` with `npm install disco-images`.

Once you've done that, you'll be able to finally use this awesome powerful anime gif package.

# ⚒ What's new ⚒
Version 0.0.9 brings a tons of new features to `disco-images`. 
These features are animals! You can now send animal GIFs.

* Animals
    * Pig (pig) - Finds a GIF of a pig.
    * Horse (horse) - Finds a GIF of a horse.
    * Dog (dog) - Finds a GIF of a dog.
    * Cat (cat) - Finds a GIF of a cat.

I have found a few bugs with embeds and currently working on a fix for it. Currently, stick with _not_ sending it in an embed.
# How to use

```js
const Discord = require('discord.js');
const client = new Discord.Client();
//Import disco-images here
const GIFs = require('disco-images');

client.once('ready', () => {
	console.log('Ready!');
});

client.on('message', async message => {
	if (message.content === '!wave') {
        //⚠IMPORTANT: Must do this step⚠
        const gif = await GIFs.wave(); 

        //Sending the wave gif:
        message.channel.send(gif);
    }
});

client.login('token');
```

## In command handler
```js
//Import disco-images
const GIFs = require("disco-images");
module.exports = {
    name: 'hug',
    description: 'Cool hug command',
    async execute(client, message, args) {
        const gif = await GIFs.hug();
        message.channel.send(gif)
    }
}
```
* Actions Available
    * Wave (wave) - Sends an anime wave GIF.
    * Hug (hug) - Sends an anime hug GIF.
    * Slap (slap) - Sends an anime slap GIF.
    * Punch (punch) - Sends an anime punch GIF.
    * Kill (kill) - Sends an anime kill GIF.
    * Kiss (kiss) - Sends an anime kiss GIF.
* Animals Available
    * Pig (pig) - Sends a GIF of a pig.
    * Horse (horse) - Sends a GIF of a horse.
    * Dog (dog) - Sends a GIF of a dog.
    * Cat (cat) - Sends a GIF of a cat.




_New ones will be added soon!_ -->
# About
Disco-Images is a powerful tool for generating anime GIFs for Discord.js.

# Installation
### Node.JS v 12.0.0 or newer is required `npm install disco-images`

# How To Use
```js
const Discord = require('discord.js');
const client = new Discord.Client();

client.on('ready', () => {
  console.log(`Logged in as ${client.user.tag}!`);
});

client.on('message', message => {
  if (message.content === '!gif') {
    
  }
});

client.login('token');