README.md

Heroes please!

🍁🍁🍁🍁🍁🍁🍁🍁🍁

This command line utility will give you a random hero from Canadian history.

Installation

First, install node. Then, using the command line (terminal in Mac or Linux, Command Prompt or PowerShell in Windows), type:

npm install -g heroes-please

Usage

You have to use the command line again:

heroes-please    # Returns a hero
--political          # Returns a political hero
--cultural        # Returns a cultural hero
--misc        # Returns a miscellaneous hero

Contributing

First, register with Github and then "fork" this repository by clicking the "fork" button on the top right of this page.

Add heroes to the heroes/ folder, in either the poltical, cultural, or misc subdirectory. Each "Hero" description is written in markdown:

# Level 1 headline, for titles
## level 2 headline, for outline elements
### maybe you feel like a level 3 headline?
> quote
[link text](link URL)
*italics*
**bold**
![image alt text](Image URL "Image Title")
etc.
- list item
- another list item 

For more details, check out the Githb Markdown cheatsheet

Once you have written a hero description to your satisfaction, submit a "pull request" by committing your changes and ticking the "Create a new branch for this commit and start a pull request" box.

I'll commit the changes and we can all enjoy them!