update README

jeegurda · Sep 7, 2022 · 87c64d9 · 87c64d9 · vercel · Sep 7, 2022
1 parent cde53df
commit 87c64d9
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,4 +3,3 @@
 .DS_Store
 .vscode
 /resources
-TODO.txt
diff --git a/README.md b/README.md
@@ -1 +1,32 @@
 # Clot
+
+## Build
+
+1. Install Node.js
+2. Build project:
+
+```bash
+$ npm i
+$ npm run build
+```
+
+3. Serve/deploy entire `./build` directory
+
+## Develop
+
+1. Install Node.js
+2. Start WDS:
+
+```bash
+$ npm i
+$ npm run start
+```
+
+3. Open http://localhost:3000
+
+## Content
+
+- Edit RU/EN texts here: `./public/texts.json`
+- Edit RU/EN content here: `./public/content.json`. `description` field is optional.
+- Badly formatted json will log an error to the console and will break site loading.
+- Bad video links will break site loading. Always check if provided link is correct and video format is playable by the target browser.`
diff --git a/public/content.json b/public/content.json
@@ -17,7 +17,7 @@
         "video": "media/app-1.mp4"
       },
       {
-        "title": "Тут текст, например",
+        "title": "В двух словах",
         "description": "some description",
         "video": "media/app-2.mp4"
       }