Tweaked the README file a bit more.

This commit is contained in:
Javier Cicchelli 2022-12-20 02:58:40 +01:00
parent d0dae4a7eb
commit d8efab9c31

View File

@ -8,20 +8,20 @@ In a nutshell, the purpose of this application is to manage a remote file system
In its current state, the application allows its users to: In its current state, the application allows its users to:
* *handle GET, POST and DELETE requests to the API endpoint;* - [x] handle GET, POST and DELETE requests to the API endpoint;*
* *require the user to login to the app to access the file system;* - [x] require the user to login to the app to access the file system;*
* *load the items located at the root folder;* - [x] load the items located at the root folder;*
* *browse through the folders hierarchy;* - [x] browse through the folders hierarchy;*
* *create new folder in the current folder location;* - [x] create new folder in the current folder location;*
* *support for pull-to-refresh on folders;* - [x] support for pull-to-refresh on folders;*
* *open JPG and PNG images in the image viewer;* - [x] open JPG and PNG images in the image viewer;*
* *upload documents from the phone or an **iCloud** location to the current folder location;* - [x] upload documents from the phone or an **iCloud** location to the current folder location;*
* *download document from the current folder location to the phone or an **iCloud** location;* - [x] download document from the current folder location to the phone or an **iCloud** location;*
* *delete existing folders in the current folder location;* - [x] delete existing folders in the current folder location;*
* *delete existing documents in the current folder location;* - [x] delete existing documents in the current folder location;*
* *show available user information in the profile;* - [x] show available user information in the profile;*
* *allow the user to logout from the app;* - [x] allow the user to logout from the app;*
* *show to the user relevant errors that could happen while using the app.* - [x] show to the user relevant errors that could happen while using the app.*
> It is necessary to clarify that, to use any **iCloud** location, the user is required to have an actual **iCloud** account and to be logged to that **iCloud** account in the phone. > It is necessary to clarify that, to use any **iCloud** location, the user is required to have an actual **iCloud** account and to be logged to that **iCloud** account in the phone.
@ -53,4 +53,4 @@ Currently, the work that has been left outside of this assignment
- [ ] Write UI tests for happy and error paths with the `XCUITest` framework; - [ ] Write UI tests for happy and error paths with the `XCUITest` framework;
- [ ] Set Xcode plugin that uses the `SwiftFormat` library to lint and format the source code on development delivery pipeline; - [ ] Set Xcode plugin that uses the `SwiftFormat` library to lint and format the source code on development delivery pipeline;
- [ ] Set Xcode plugin that uses `DocC` library to generate Xcode and web-ready documentation on release delivery pipeline; - [ ] Set Xcode plugin that uses `DocC` library to generate Xcode and web-ready documentation on release delivery pipeline;
- [ ] Set [Xcode Cloud](https://developer.apple.com/xcode-cloud/) as continuous integration and delivery service to **TestFlight** and to the **App Store**. - [ ] Set [Xcode Cloud](https://developer.apple.com/xcode-cloud/) as continuous integration and delivery service to **TestFlight** and to the **App Store**.