bookquotes

Welcome to bookquotes!

Open for Hacktoberfest 2021

A simple NPM Package which returns

random Lines from people’s favorite book with names of the author as well as the book . It provides great and aesthetic quotes to display in your application.
random inspirational quotes. Get your daily quote and stay motivated!

If you like to read books, literature and want to stay motivated and inspired, this package is for you!

Click here to view this package on NPM registry. Check the homepage here.

Getting started

$ npm install --save bookquotes

Installation

This is a Node.js module available through the npm registry.

Before installing, download and install Node.js.

Installation is done using the npm install command:

$ npm install bookquotes

Usage

getLines() method returns an object containing line , book, and author.

{
  "line": "The gods grow jealous of too much contentment anywhere, and they show their displeasure all of a sudden.",
  "book": "Malgudi Days",
  "author": "R. K. Narayan"
}

getRandomLine() method returns a random aesthetic line!

const Line = require("bookquotes");

console.log(Line.getRandomLine()); // generates a single line

console.log(Line.getLines()); // generates an object having a line, name of book and author.

_getRandomLine(typeCode)_ method returns a specific type line.

const Line = require("bookquotes");

console.log(Line.getRandomLine("isp")); // for inspiring quote

console.log(Line.getLine("isp"));

Type codes
```
'isp' = inspire
```

Testing the package!

All the tests are in tests folder.

Want to contribute?

Please check issues here!

Add Lines from your Favorite Books (Recommended for beginners)

Follow the JSON format and add your content(your favorite line from a book or an inspirational quote) in data file.

Please check HOW TO CONTRIBUTE here!