From 0609fb771b6b3e46c3f2770e85489f504ccfbb00 Mon Sep 17 00:00:00 2001 From: rui hildt Date: Mon, 3 Aug 2020 00:55:38 +0200 Subject: [PATCH] Update Readme with more precise usage instructions --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a84bb61..cde7e28 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,15 @@ A react application using typescript showing the albums of an artist the user is searching for using a GraphQL endpoint. ## Using the app - - Clone the git repo [from here](https://github.com/ruihildt/spoti-search). - - Installing libraries: `yarn install` - - Running the app: `yarn start` + +### Installation +1. Clone the git repo [from here](https://github.com/ruihildt/spoti-search). +2. Install libraries using yarn (can also be run with npm): `yarn install` + +### Usage + - Run the app: `yarn start` - Build the app to deploy it: `yarn build` + - Run the tests: `yarn test` ## Tech Stack - [CRA with Typescript](https://create-react-app.dev/docs/adding-typescript/)