README.md

History 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
--people          # Returns a person
--events        # Returns an event
--trends        # Returns a trend

Contributing

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

Once you have an account, you can make changes to this repository directly from the Github repository web page. Add historical figures by clicking the Create New File button (top right) to add a new file to the history/people folder: Similarly, add events to the history/events folder, and trends to the history/trends folder. Each description is written in the markdown syntax:

# 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 adescription 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 respond with comments and eventually commit the changes, and we can all enjoy them!