zackharley / readme

A template for making great READMEs

readme {

Here's a short description of my project

I also have a longer summary here so I can provide more details

Contents

1. Installation
2. Usage
3. Documentation
4. Person
5. Dog
6. License

Installation

Explain how to install your project. For example (this isn't my package):

npm install readme

Usage

Explain how to build/run your project. For example:

npm run start

Documentation

If your project has an API, you can include documentation. Let's say for the sake of example, this readme project has two JavaScript classes called Person and Dog. We could document their public methods as follows.

Person

• sayName - Logs the Person's name to the console.
• sayAge - Logs the Person's age to the console.

Dog

• bark - Logs the Dog's bark to the console.

Person

The Person class contains only non-static methods, so an instance of the class must be created to be used. The constructor takes the following arguments:

new Person(name, age)

For example:

const zack = new Person('Zack', 20);

sayName()

This method logs the name of the Person.

zack.sayName();
// < - 'My name is Zack!'

sayAge()

This method logs the age of the Person.

zack.sayAge();
// < - 'I am 20 years old!'

Dog

The Dog class contains only non-static methods, so an instance of the class must be created to be used. The constructor takes the following arguments:

new Dog(name, barkSound)

For example:

const millie = new Dog('Millie', 'ruffff');

bark()

This method logs the bark sound of the Dog.

millie.bark();
// < - 'ruffff'

License

2016 © Zack Harley

🍴Fork away!

}