diff --git a/README.md b/README.md index 5d83a6f..ba8b2f9 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ On some READMEs, you may see small images that convey metadata, such as whether Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. ## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. +In order to run this project locally, you can clone or download this project and run ```npm install``` to install all the dependencies that are listed in the ```package.json``` file. After the dependencies has been installed, then run the command ```npm run serve``` to run it. ## Usage Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.