Add section about file upload in README

Author: RadoRado

.env.example

@@ -6,5 +6,6 @@ FILE_UPLOAD_STORAGE="local" # s3
 
 AWS_S3_ACCESS_KEY_ID=""
 AWS_S3_SECRET_ACCESS_KEY=""
-AWS_STORAGE_BUCKET_NAME="django-styleguide-example"
-AWS_S3_REGION_NAME="eu-central-1"
+AWS_STORAGE_BUCKET_NAME=""
+AWS_S3_REGION_NAME=""
+AWS_S3_CUSTOM_DOMAIN=""

README.md

@@ -26,6 +26,7 @@
   * [`HTTP Only` / `SameSite`](#http-only--samesite)
   * [Reading list](#reading-list)
 - [Example List API](#example-list-api)
+- [File uploads](#file-uploads)
 - [Helpful commands for local development without docker-compose](#helpful-commands-for-local-development-without-docker-compose)
 - [Helpful commands for local development with docker-compose](#helpful-commands-for-local-development-with-docker-compose)
 - [Deployment](#deployment)
@@ -229,6 +230,25 @@ Example data structure:
 }
 ```
 
+## File uploads
+
+Following this article - <https://www.hacksoft.io/blog/direct-to-s3-file-upload-with-django> - there's a rich file-upload implementation in the Django Styleguide Example.
+
+Everything is located in the `files` app.
+
+Configuration wise, everything is located in [`config/settings/files_and_storages.py`](config/settings/files_and_storages.py)
+
+Additionally, you can check the available options in [`.env.example`](.env.example)
+
+Currently, the following is supported:
+
+1. Standard local file upload.
+1. Standard S3 file upload.
+1. Using CloudFront as CDN.
+1. The so-called "direct" upload that can work both locally and with S3 (for more context, [check the article](https://www.hacksoft.io/blog/direct-to-s3-file-upload-with-django))
+
+Feel free to use this as the basis of your file upload needs.
+
 ## Helpful commands for local development without docker-compose
 
 To create Postgres database: