Update documentation

CHANGELOG.md

@@ -3,10 +3,16 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
-## [Unreleased]
+## [3.3.0] - WIP
 ### Added
-- OpenGraph image tag #269
+- Added Screencloud client support (https://screencloud.net).
-- Table view for users #226
+- OpenGraph image tag (issue #269).
+
+### Changed
+- The list mode is now available also for non-admin accounts (issue #226).
+
+### Fixed
+- Linux script strange response code in headless mode.
 
 ## [3.2.0] - 2020-09-05
 ### Added

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "sergix44/xbackbone",
   "license": "AGPL-3.0-only",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "A lightweight ShareX PHP backend",
   "type": "project",
   "require": {

docs/changelog.md

@@ -8,6 +8,17 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [3.3.0] - WIP
+### Added
+- Added Screencloud client support (https://screencloud.net).
+- OpenGraph image tag (issue #269).
+
+### Changed
+- The list mode is now available also for non-admin accounts (issue #226).
+
+### Fixed
+- Linux script strange response code in headless mode.
+
 ## [3.2.0] - 2020-09-05
 ### Added
 - Added support to use Azure Blob Storage account as storage location.

docs/clients.md

@@ -1,16 +1,33 @@
 ---
 layout: default
-title: Clients
+title: Client Configuration
 nav_order: 5
 ---
 
 # Clients Configuration
 
-## ShareX Configuration
+## ShareX (Windows)
 Once you are logged in, just go in your profile settings and download the ShareX config file for your account.
 
-## Linux/Mac Support
+## Screencloud (Windows, Mac and Linux)
-Since ShareX does not support Linux, XBackBone can generate a script that allows you to share an item from any tool:
+Once you are logged in, go in your profile account and click on the Screencloud button.
+Now open Screencloud, open "Preferences" > "Online Services" tab > click "More Services" > and "Install from URL"
+and paste the URL copied from XBackBone, and all should work out-of-the-box.
+
+If for whatever reason you need to change the instance url or the token, just edit the settings of the XBackBone plugin.
+
+## uPic (Mac)
+This tool does not support plugins or custom configuration, but you can configure it manually:
+In preferences, you should add "Custom" host and configure it as follows:
+- **API URL:** Your instance upload url, like `http://example.com/upload`
+- **Request method:** POST
+- **File field:** file
+- **URL Path:** ["url"]
+- In "Other fields", in the body section, you should add the field `token`, with your upload token.
+- In "Other fields", in the headers section, you should add the field `Content-Type`, with the value `application/x-www-form-urlencoded`.
+
+## Bash Script (Linux, Mac, WSL)
+XBackBone can generate a script that allows you to share an item from any tool, even headless servers:
 + Login into your account
 + Navigate to your profile and download the Linux script for your account.
 + Place the script where you want (ex. in your user home: `/home/<username>`).

docs/index.md

@@ -18,8 +18,8 @@ XBackBone is a simple and lightweight PHP file manager that support the instant
 </p>
 
 ## Main Features
-+ Supports every upload type from ShareX.
++ Multiple clients supported: ShareX, Screencloud, uPic, ...
-+ Config generator for ShareX.
++ Config generator for ShareX, Screencloud.
 + Low memory footprint.
 + Multiple backends support: Local storage, AWS S3, Google Cloud, Azure Blob Storage, Dropbox, FTP(s).
 + Web file upload.