From e2ca6b7aeb8c02bc5638520a5777c2656d5da349 Mon Sep 17 00:00:00 2001 From: Bogdan Polygalov <77894393+miamib34ch@users.noreply.github.com> Date: Mon, 4 Sep 2023 23:59:14 +0500 Subject: [PATCH] Update README.md --- README.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 0b3a590..fbda474 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ -# Image Feed +# **ImageFeed** -# Ссылки +## **Ссылки** - [Дизайн в Figma](https://tinyurl.com/image-feed-figma) - [Unsplash API](https://unsplash.com/documentation) +- [Скринкаст готового приложения]() -# Назначение и цели приложения +## **Назначение и цели приложения** Многостраничное приложение предназначено для просмотра изображений через API Unsplash. @@ -14,16 +15,16 @@ - Просмотр бесконечной ленты картинок из Unsplash Editorial. - Просмотр краткой информации из профиля пользователя. -# Краткое описание приложения +### Краткое описание приложения - В приложении обязательна авторизация через OAuth Unsplash. - Главный экран состоит из ленты с изображениями. Пользователь может просматривать ее, добавлять и удалять изображения из избранного. - Пользователи могут просматривать каждое изображение отдельно и делиться ссылкой на них за пределами приложения. - У пользователя есть профиль с избранными изображениями и краткой информацией о пользователе. -# Функциональные требования +## **Функциональные требования** -# Авторизация через OAuth +### Авторизация через OAuth Для входа в приложение пользователь должен авторизоваться через OAuth. @@ -44,7 +45,7 @@ 1. При нажатии на «ОК» пользователь переходит обратно на экран авторизации; 5. Если авторизация прошла успешно, то браузер закрывается. В приложении открывается экран с лентой. -## Просмотр ленты +### Просмотр ленты В ленте пользователь может просматривать изображения в ленте, переходить к просмотру отдельного изображения и добавлять их в избранное. @@ -72,7 +73,7 @@ 7. При нажатии на иконку профиля пользователь может перейти в профиль; 8. Пользователь может переключаться между экранами ленты и профиля с помощью таб бара. -## Просмотр изображения на весь экран +### Просмотр изображения на весь экран Из ленты пользователь может перейти к просмотру изображения на весь экран и поделиться им. @@ -95,7 +96,7 @@ 2. Пользователь может закрыть меню свайпом вниз или при нажатии на крестик; 3. Если открытие системного меню при нажатии на кнопку “загрузить или поделиться изображением” не настроено — оно не будет показываться; -## Просмотр профиля пользователя +### Просмотр профиля пользователя Пользователь может перейти в свой профиль, чтобы посмотреть данные профиля или выйти из него. @@ -119,12 +120,13 @@ 3. Если алерт не настроен, то при нажатии на кнопку выхода ничего не происходит, пользователь не может разлогиниться; 3. Пользователь может переключаться между экранами ленты и профиля с помощью таб бара. -# Нефункциональные требования - -## Технические требования +## **Технические требования** 1. Авторизация работает через OAuth Unsplash и POST запрос для получения Auth Token. 2. Лента реализована с помощью UITableView. 3. В приложении использованы UImageView, UIButton, UILabel, TabBarController, NavigationController, NavigationBar, UITableView, UITableViewCell. 4. Приложение должно поддерживать устройства iPhone с iOS 13 или выше, предусмотрен только портретный режим. 5. Все шрифты в приложении должны быть выбраны из множества стандартных для платформы (для iOS 13 - это [SF Pro](https://developer.apple.com/fonts/)). +6. Используются внешние зависимости через SPM: Kingfisher, ProgressHUD, SwiftKeychainWrapper. + +## **Инструкция по запуску**