feat: readme update

Author: SergeyKardashev

README.md

@@ -1,21 +1,56 @@
-<!--
-[![Статус тестов](../../actions/workflows/tests.yml/badge.svg)](../../actions/workflows/tests.yml) 
+# Фотосоцсетка
 
--->
-# Проект Место - Соцсеть для фоток
+Соцсеть чтобы делиться фотками, лайкать их и меряться лайками. 
+Учебный проект. Цель - закрепить навыки создания приложений на React и Express
 
-### Описание проекта
+![Image alt](https://github.com/SergeyKardashev/photo/raw/assets/images/Photonetwork_thumb_1.jpg)
 
-Учебный проект для отработки навыков программирования фронта и бэка на javascript и чуток html и css.
+[Макет](https://www.figma.com/file/2cn9N9jSkmxD84oJik7xL7/JavaScript.-Sprint-4?node-id=0%3A1) в Figma
 
-### Технологии
+## Содержание
+- Функции
+- Что сделано
+- Планы по доработке
+- Стэк технологий
+- Установка
 
-- html, css, js по БЭМ
-- frontend на React (webpack)
+## Функции
+- Регистрация и авторизация пользователей;
+- Просмотр ленты фоток со счетчиком лайков, добавление фоток, простановка и снятие своих лайков;
+- Редактирование никнейма и информации о себе.
+
+## Что сделано
+- Настроена инфраструктура и создан сервер на express;
+- Подключена база данных, созданы схемы и модели ресурсов API;
+- Реализовано логирование, аутентификация и авторизация на сервере;
+- Бэкенд задеплоен на Яндекс Облако;
+- Свёрстаны компоненты на React, разметка портирована в его формат;
+- Описана логика и вёрстка страниц регистрации, логина, редактирования профиля;
+- Реализованы асинхронные GET- и POST-запросы к API;
+- Проработаны авторизованные и неавторизованные состояния, простановка лайков.
+
+## Планы по доработке
+- Добавление интернационализации с помощью i18next;
+- Перевод на TypeScript для повышения надежности;
+- Перевод проекта на Redux и SCSS для упрощения поддержки и расширения;
+- Добавление функции смены e-mail;
+- Добавление функции смены и восстановления пароля.
+
+## Стэк технологий
+- HTML, CSS, js, БЭМ, Grid и Flexbox
+- frontend на React (webpack через CRA), React hooks
 - ООП, модульный подход, асинхронность
 - роутинг, авторизация
 - backend на Node.js и Express JS, деплой на Ubuntu в Яндекс.Облаке
 - хехирование паролей, авторизация на токенах, сбор логов
 
-[Макет в Figma](https://www.figma.com/file/2cn9N9jSkmxD84oJik7xL7/JavaScript.-Sprint-4?node-id=0%3A1)
+## Установка
+- Склонируйте репозиторий `git@github.com:SergeyKardashev/photo.git`
+- Установите зависимости `npm install`
+- Запустите сервер `npm run start`
+
+## Результаты
+Закрепил навыки создания приложений на React, Express с MongoDB
 
+## Системные требования
+Node.js версии 18.16.0