Update documentation (#2850)

* Update documentation
abraunegg · Sep 26, 2024 · bb6989c · bb6989c
1 parent 410ffe4
commit bb6989c
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/docs/usage.md b/docs/usage.md
@@ -65,7 +65,7 @@ Before reading this document, please ensure you are running application version
 ### Memory Usage
 Starting with version 2.5.x, the application has been completely rewritten. It is crucial to understand the memory requirements to ensure the application runs smoothly on your system.
 
-Testing indicates that during a `--resync` operation or a full online scan, the client may use approximately 1GB of memory for every 100,000 objects stored online. This occurs because the client queries the OneDrive API for all objects before processing them locally. Once processing is complete, the memory is released back to the system.
+During a `--resync` or full online scan, the OneDrive Client may use approximately 1GB of memory for every 100,000 objects stored online. This is because the client retrieves data for all objects via the OneDrive API before processing them locally. Once this process completes, the memory is freed. To avoid performance issues, ensure your system has sufficient available memory. If the system starts using swap space due to insufficient free memory, this can significantly slow down the application and impact overall performance.
 
 To avoid potential system instability or the client being terminated by your Out-Of-Memory (OOM) process monitors, please ensure your system has sufficient memory allocated or configure adequate swap space.
 

diff --git a/readme.md b/readme.md
@@ -45,14 +45,24 @@ Refer to [Frequently Asked Questions](https://github.com/abraunegg/onedrive/wiki
 ## Have a question
 If you have a question or need something clarified, please raise a new discussion post [here](https://github.com/abraunegg/onedrive/discussions)
 
+## Supported Application Version
+Support is only provided for the current application release version or newer 'master' branch versions.
+
+The current release version is: [![Version](https://img.shields.io/github/v/release/abraunegg/onedrive)](https://github.com/abraunegg/onedrive/releases)
+
+Check the version of the application you are using `onedrive --version` and ensure that you are running either the current release or compile the application yourself from master to get the latest version.
+
+To check your version, run: `onedrive --version`. Ensure you are using the current release or compile the latest version from the master branch if needed.
+
+If you are using an older version, you must upgrade to the current release or newer to receive support.
+
 ## Basic Troubleshooting Steps
 If you are encountering any issue running the application please follow these steps first:
 1.  Check the version of the application you are using `onedrive --version` and ensure that you are running either the latest [release](https://github.com/abraunegg/onedrive/releases) or built from master.
 2.  Configure the application to only use IPv4 network connectivity, and then retest. 
 3.  Configure the application to only use HTTP/1.1. operations with IPv4 network connectivity, and then retest.
 4.  If the above points do not resolve your issue, upgrade your 'curl' version to the latest available by the curl developers. Refer to https://curl.se/docs/releases.html for details.
 
-
 ## Reporting an Issue or Bug
 > [!IMPORTANT]
 > Please ensure that issues reported as bugs are indeed software bugs. For installation problems, distribution package/version issues, or package dependency concerns, please start a [Discussion](https://github.com/abraunegg/onedrive/discussions) instead of filing a bug report.