Project Name

Short blurb about your project idea.

One or two paragraphs about your project and what it does.

---

Author

Your name

• Initial work - repository-name (Repository space)
• Released on cloud-provider (Cloud provider)
• My professional profile on LinkedIn

Showcase

This project was designed to demonstrate:

• Technology 1
  • Tech 1 subitem
• Technology 2
• .
• .
• .
• Technology N

Usage example

Bring the best usages of your project.

For more examples and usage, please refer to the Wiki.

---

Installation

Describe how to get your project running.

MacOS & Linux:

npm install my-module --save

Windows:

edit autoexec.bat

---

Development setup

Describe how to install all development dependencies and consider do this for multiple platforms.

make install
npm test

Running the tests

Remember this is a showcase, thus your potential employer might want to see an automated test-suite of some kind up running.

---

Built With

• Maven - Dependency Management
• Heroku CLI - To deploy on Heroku

Release History

• 0.2.1
  • CHANGE: Update docs (module code remains unchanged)
• 0.2.0
  • CHANGE: Refactoring - Remove setAnyMethod()
  • ADD: Add newSomething()
• 0.1.1
  • FIX: Crash when calling defaultXYZ() (Thanks @ContributorName)
• 0.1.0
  • The first proper release
• 0.0.1
  • Initial work

---

Contributing

1. Fork it (https://github.com/yourname/yourproject/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request