• What is? and Why?
• Intstallation
• Usage
• getRandomQuote()
• getRandomQuote(false)
• Contributing
• Credits
• License

What is? and Why?

Quoteair is a free to use npm package developed by 'TheShiningBoots' it aims at providing a HUGE library of quotes, currently at 3500+, to be used in APIs or Applications.

Intstallation

Quoteair can be installed through the npm registry via the following command

npm i quoteair

The package can also be downloaded directly via github by adding the following line of code to your dependencies in your package.json

"Quoteair": "TheShiningBoots/Quoteair" for example -

"dependencies": {
    "Quoteair": "TheShiningBoots/Quoteair"
}

For more information regarding the above visit npm's official documentation

Usage

Quoteair can be used for various applications whether it be APIs or applications. An example has been given in the examples folder, that example is also given below.

const quoteair = require('quoteair');

// Outputs the quote with the author 
console.log(quoteair.getRandomQuote())

// Outputs the quote without the author
console.log(quoteair.getRandomQuote(false))

getRandomQuote()

Outputs the quote and author as a json format

{
    'quote': 'A random quote',
    'author': 'The author of the quote'
}

getRandomQuote(false)

Outputs the quote as plain text, **Does not include the author

quote

Contributing

Contribution are very significant and are really welcome, to contribute you may open a pull request and get it merged with the main branch, depending on what type of changes you are making you must include it in the pull request, common topics may include but are not limited to addition of new quotes and optimizations. To learn more about each please read Contributing.md

Credits

This project has only been possible through the help of various open-source projects though it would be impossible for me to list them all, most of them were found using the quotes and the quotes-api tags on github.

License

The license file of the software can be found in the root directory its the GPL-3 License.