saif-malik-01 / bookquotes

Generate lines, author, and book name from people's favorite books!

bookquotes

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.

If you like to read books or literature 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 inspire quote 

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

• Type codes

  'isp' = inspire
  

• testing the package!

const favline = require("./index.js");

var myLine = favline.getLines();

console.log("*********************************");
console.log("WE ARE GRAMMAR_NAZIS\n");
console.log("*********************************");

console.log("The lines I love- " + myLine.line);
console.log("Written by - " + myLine.author);
console.log("From the book - " + myLine.book);

Want to contribute?

Please check issues here!

Add Lines from your Favorite Books (Recommended for beginners)

Follow the JSON format and add your content in data file.

Please check HOW TO CONTRIBUTE here!

License

Inspired by this project