dcgauld / starwars

Inspirational quotes from the Star Wars films.

starwars

starwars is a simple Node.js module that allows you to insert a random Star Wars quote into your site, or view one through the command line.

Usage

Simply install through npm by running...

npm install starwars

...and require the module from your Node.js application. You're good to go! Either insert a single (random) quote, or retrieve a list containing all of the available quotes.

var starwars = require('starwars');

console.log(starwars()); // "No. I am your Father."
console.log(starwars()); // "Great shot kid, that was one in a million."
console.log(starwars.quotes); // ["No. I am your Father.", "Great shot kid, that was one in a million.",...]

Command Line

starwars can also be used within the command line. Simply install globally through npm by running...

npm install starwars -g

...and then typing starwars into your console. A random quote will then be displayed on the screen (especially helpful if you're having a bad day and need to read some inspirational text).

You can also type starwars -all into your console to display all of the available quotes.

starwars's Issues

No link to this repo on npmjs.org

Hi!

I was about to use this library for the fun of it and found it on npmjs.org, but there's no link to this repo in the package which made me feel a bit unsafe since I couldn't verify the source code so there wasn't anything malicious in it.

Think it would be a great idea to add this repo-link to your npmjs.org package: https://www.npmjs.com/package/starwars :)

Great job!

add more quotes

PR to add characters and possibly movie source?

Hello @dcgauld
Would you accept a non breaking PR to add the character's name for each quotes?

Maybe add the source movie too...

Existing functions would still work as is.
Would probably add something like starwars.withCharacter() (likewise for the CLI)

tx