From 4183b1a2db75fe317a727b0a2fe05d2dddb244ac Mon Sep 17 00:00:00 2001
From: Chris <christian@haschek.at>
Date: Mon, 24 Dec 2018 00:53:25 +0100
Subject: [PATCH] more readmes

---
 README.md   | 14 ++++++++++++++
 rtfm/API.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 69 insertions(+)
 create mode 100644 rtfm/API.md

diff --git a/README.md b/README.md
index 61001cb..c25f541 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,15 @@
 # This is the development branch for Version 2 do not use in production
 Test site: https://dev.pictshare.net/ (only sometimes on)
 
+Table of contents
+=================
+* [Installation](/rtfm/INSTALL.md)
+* [Docker](/rtfm/DOCKER.md)
+* [API](/rtfm/API.md)
+* [Addons/Integration](/rtfm/INTEGRATIONS.md)
+
+---
+
 ## New Features in v2:
 
 - Added text hosting (like pastebin)
@@ -12,10 +21,15 @@ Test site: https://dev.pictshare.net/ (only sometimes on)
 - Added WebP to images (and conversion from jpg,png to webp)
 - Massive code rework. Actually we designed it from the ground up to be more modular and easier to debug
 
+## Breaking changes
+
+- New API system. Only single file uploads now via /api/upload.php (POST var name is "file"). [read more..](/rtfm/API.md)
+
 ## Status
 
 - [x] Duplicate detection
 - [x] Write permission detection
+- [ ] Upload via link
 
 ### Config options
 
diff --git a/rtfm/API.md b/rtfm/API.md
new file mode 100644
index 0000000..0b33774
--- /dev/null
+++ b/rtfm/API.md
@@ -0,0 +1,55 @@
+# API
+
+## upload.php
+
+- URL https://pictshare.net/api/upload.php
+- Method: POST file
+- Post var name: file
+- Answer type: JSON
+
+If the upload was successful answer will look like this
+
+```
+{
+    "status":"ok",
+    "hash":"y1b6hr.jpg",
+    "url":"https://pictshare.net/y1b6hr.jpg"
+}
+```
+
+If there is an error the server will answer with status:err and a reason
+
+```
+{
+    "status":"err",
+    "reason":"Unsupported filetype"
+}
+```
+
+### Example
+
+Uploading a file called test.jpg via curl
+
+```curl -F "file=@test.jpg" https://pictshare.net/api/upload.php```
+
+Answer from the server:
+```{"status":"ok","hash":"y1b6hr.jpg","url":"https://pictshare.net/y1b6hr.jpg"}```
+
+---
+
+## pasetebin.php
+- URL https://pictshare.net/api/pastebin.php
+- Method: POST/GET text
+- Post var name: api_paste_code
+- Answer: Plaintext URL to pasted bin
+
+This API can be used to directly post text. Server responds with the URL to the bin or with an error message
+
+### Example
+
+Creating a new text bin that ready "Hello World"
+
+```url -F "api_paste_code=Hello World" https://pictshare.net/api/pastebin.php```
+
+Answer from the server:
+```https://pictshare.net/vekjy4e5rr.txt```
\ No newline at end of file