From ba0af108ddc47ba6a5d315409defa8d0b6be2936 Mon Sep 17 00:00:00 2001
From: "Viktor.Sidorets" <viktor.sidorets@south.rt.ru>
Date: Thu, 10 Mar 2022 00:07:02 +0300
Subject: [PATCH] Up readme

---
 .gitignore | 17 +++++++++++++++--
 readme.md  | 44 +++++++++++++++++++++++++++++++++-----------
 2 files changed, 48 insertions(+), 13 deletions(-)

diff --git a/.gitignore b/.gitignore
index 28634d9..b758755 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,16 @@
-/node_modules
+# IDE, System
+.DS_Store
+.idea
+.vscode
+
+# Packages
+node_modules/
+npm-debug.log
+package-lock.json
+
+# Auto-generated
 /process
-/store
\ No newline at end of file
+/store
+
+# Dump
+/work
diff --git a/readme.md b/readme.md
index d4e974b..52f51bd 100644
--- a/readme.md
+++ b/readme.md
@@ -1,16 +1,27 @@
-Утилита предназначена для создания локальных бекапов fig файлов
+## Figma backup
+<i>Утилита для создания локальных бекапов fig файлов</i>
+<hr>
 
-Для работы необходимо:
+## Для работы понадобятся:
 1. bash консоль
-2. Установленная node (проверено на версии v16.13.0)
-3. Для полной версии, установленный python (проверено на Python 2.7.18)
+2. Установленная NodeJS (проверено на версии v16.13.0)
+3. Для Full запуска, установленный python (проверено на Python 2.7.18)
 
-Ligth запуск
+## Режимы запуска:
+
+### Light запуск
 
 Предусмотрен вариант запуска в режиме простого скачивания.
 Для этого необходимо в корне проекта
 1. Установить зависимости node (команда `npm i`)
-2. Выполнить команду `node download_figma_files.js figmaLogin=<ваш логин> figmaPassword=<ваш пароль> figmaUrl=<полный адрес файла, который необходимо скачать>`
+2. Выполнить команду:
+```
+node download_figma_files.js
+  figmaLogin=<ваш логин>
+  figmaPassword=<ваш пароль>
+  figmaUrl=<полный адрес файла, который необходимо скачать>
+```
+
 В случае если необходимо скачать несколько файлов, можно подготовить конфигурационный json файл следующего формата:
 `[
     {
@@ -25,18 +36,29 @@ Ligth запуск
         "team": "<название команды>"
     }
 ]`
-Загрузка файлов по конфигурационному файлу осуществляется командой `node download_figma_files.js figmaLogin=<ваш логин> figmaPassword=<ваш пароль> igmaFilesList=<путь до файла>`
+Загрузка файлов по конфигурационному файлу осуществляется командой:
+```
+node download_figma_files.js
+  figmaLogin=<ваш логин>
+  figmaPassword=<ваш пароль>
+  figmaFilesList=<путь до файла>
+```
 
-В ligth запуске все файлы будут сохранены в директорию `./process/_download`. Если эта директория не пустая, существующие в ней файлы будут переименованы
+В Light запуске все файлы будут сохранены в директорию `./process/_download`. Если эта директория не пустая, существующие в ней файлы будут переименованы
 
+<br>
 
-Full запуск
+### Full запуск (Python)
 
-Требует установленного python, отличается от ligth версии следующим:
+Требует установленного python, отличается от Light версии следующим:
 1. Скачивает все файлы для команд, указанных в `./config/get_figme_files_list.yml`
 2. Анализирует время изменения файла в figma и если файл не менялся с прошлого запуска пропускает их
 
-Для запуска полной версии необходимо выполнить команду `./manage.sh <ваш логин> <ваш пароль>`.
+Для запуска полной версии необходимо выполнить команду:
+```
+./manage.sh <ваш логин> <ваш пароль>
+```
+
 Файлы будут сохранены в `./store`, если какие-то файлы были обновлены, предыдущие версии сохраняются в `./store/<дата запуска>` 
 
 Настройки: