Here's a short description of my project
I also have a longer summary here so I can provide more details
Explain how to install your project. For example (this isn't my package):
npm install readme
Explain how to build/run your project. For example:
npm run start
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.
bark
- Logs the Dog's bark to the console.
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);
This method logs the name of the Person.
zack.sayName();
// < - 'My name is Zack!'
This method logs the age of the Person.
zack.sayAge();
// < - 'I am 20 years old!'
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');
This method logs the bark sound of the Dog.
millie.bark();
// < - 'ruffff'
2016 © Zack Harley
🍴Fork away!