more readmes

This commit is contained in:
Chris
2018-12-24 00:53:25 +01:00
parent e922f9c907
commit 4183b1a2db
2 changed files with 69 additions and 0 deletions

View File

@@ -5,6 +5,15 @@
# This is the development branch for Version 2 do not use in production # This is the development branch for Version 2 do not use in production
Test site: https://dev.pictshare.net/ (only sometimes on) 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: ## New Features in v2:
- Added text hosting (like pastebin) - 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) - 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 - 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 ## Status
- [x] Duplicate detection - [x] Duplicate detection
- [x] Write permission detection - [x] Write permission detection
- [ ] Upload via link
### Config options ### Config options

55
rtfm/API.md Normal file
View File

@@ -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```