BSA-183: * readme

Author: nikita-remeslov

README.md

@@ -1,9 +1,20 @@
-Starter for **HTTP, REST / WS** homework. Binary Studio Academy
+# HTTP, REST, WebSockets
 
-## Installation
+## 🏃‍♂️ Simple start
 
-`yarn install`
+1. **`npm install`** at the root
+2. **`npm run dev`** at the root
+3. open **`http://localhost:3333/`**
 
-`yarn start`
+## 🧹 Code style
 
-open http://localhost:3002/
+Run **`npm run format:check`** at the root to check code style.
+
+Run **`npm run format:fix`** at the root to fix code style.
+
+## 💡 PS
+
+The project has a [Prettier](https://prettier.io/) set up, to validate your code.
+Please use it!
+
+## 🤞 Good luck

package-lock.json

@@ -1,14 +1,14 @@
 {
   "name": "http-ws-hw-starter",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Starter for HTTP / WS homework. Binary Studio Academy",
   "type": "module",
   "engines": {
     "node": "20.x.x",
     "npm": "10.x.x"
   },
   "scripts": {
-    "start": "nodemon --exec \"node --loader ts-node/esm\" src/server.ts",
+    "dev": "nodemon --exec \"node --loader ts-node/esm\" src/server.ts",
     "build": "tsc",
     "format:check": "npx prettier --check \"**/*.{ts,mjs,css,md,html}\"",
     "format:fix": "npx prettier --write \"**/*.{ts,mjs,css,md,html}\""
@@ -27,7 +27,7 @@
   },
   "devDependencies": {
     "nodemon": "3.0.2",
-    "prettier": "^3.1.1",
+    "prettier": "3.1.1",
     "ts-node": "10.9.2",
     "typescript": "5.3.3"
   }