From 87c64d9000374191e2b8504f35711a5edc27bfa6 Mon Sep 17 00:00:00 2001 From: Shagen A Date: Wed, 7 Sep 2022 16:55:07 +0400 Subject: [PATCH] update README --- .gitignore | 1 - README.md | 31 +++++++++++++++++++++++++++++++ public/content.json | 2 +- 3 files changed, 32 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index f5ad636..a0f5e82 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,3 @@ .DS_Store .vscode /resources -TODO.txt diff --git a/README.md b/README.md index c673f26..4794697 100644 --- 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 index 582f2c8..628ac8c 100644 --- 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" }