Merge pull request #3 from Cophr/chore/yarn-ignore

chore: ignore yarn files and change README.md

.github/workflows/ci.yml

@@ -62,6 +62,9 @@ jobs:
           node-version: 16
           cache: "yarn"
 
+      - name: Upgrade yarn
+        run: yarn set version stable
+
       - name: Install Dependencies
         run: yarn install --frozen-lockfile
 

.gitignore

@@ -1,6 +1,8 @@
 # compiled output
 /dist
 /node_modules
+/.yarn
+.yarnrc.yml
 
 # Logs
 logs

README.md

@@ -29,33 +29,33 @@
 ## Installation
 
 ```bash
-$ npm install
+$ yarn install
 ```
 
 ## Running the app
 
 ```bash
 # development
-$ npm run start
+$ yarn start
 
 # watch mode
-$ npm run start:dev
+$ yarn start:dev
 
 # production mode
-$ npm run start:prod
+$ yarn start:prod
 ```
 
 ## Test
 
 ```bash
 # unit tests
-$ npm run test
+$ yarn test
 
 # e2e tests
-$ npm run test:e2e
+$ yarn test:e2e
 
 # test coverage
-$ npm run test:cov
+$ yarn test:cov
 ```
 
 ## Support