README

gif-search

A javascript module for searching gif images

Getting Started

import gifSearch from 'gif-search';

// Search for a gif
gifSearch.query('cat').then(
    gifUrl => console.log(gifUrl)
);

// Search for a random gif
gifSearch.random('cat').then(
    gifUrl => console.log(gifUrl)
);

// Change the API Key
gifSearch.setAPIKey('my-api-key');

Installing

npm install gif-search

Running the tests

npm test

Built With

Gipy API
Rollup - module bundler
Request - make http calls

Contributing

Please read CONTRIBUTING.md for details on contributing to the repository.

Development

Clone the repository in an empty directory.

Note:

There is an issue with the aws-sign2 module used in the request module with rollup.

To get this working in your local development environment, you may need to manually fix the issue until the fix gets published on npm.

Versioning

The project uses Semver for versioning. To check the released versions, see the tags on this repository.

License

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

Usage no npm install needed!