Update README.md

This commit is contained in:
Bill Bittner 2018-03-08 09:34:23 -08:00 committed by GitHub
parent 18486134c3
commit 059684e0b0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -33,16 +33,16 @@ Spee.ch is a web app that reads and publishes images and videos to and from the
* example: `curl https://spee.ch/api/claim/resolve/doitlive/xyz` * example: `curl https://spee.ch/api/claim/resolve/doitlive/xyz`
* /api/claim/list/:name * /api/claim/list/:name
* example: `curl https://spee.ch/api/claim/list/doitlive` * example: `curl https://spee.ch/api/claim/list/doitlive`
* /api/claim/availability/:name ( * /api/claim/availability/:name
* returns `true`/`false` for whether a name is available through spee.ch * returns the name if it is available
* example: `curl https://spee.ch/api/claim/availability/doitlive` * example: `curl https://spee.ch/api/claim/availability/doitlive`
* /api/channel/availability/:name ( * /api/channel/availability/:name
* returns `true`/`false` for whether a channel is available through spee.ch * returns the name if it is available
* example: `curl https://spee.ch/api/channel/availability/@CoolChannel` * example: `curl https://spee.ch/api/channel/availability/@CoolChannel`
#### POST #### POST
* /api/claim/publish * /api/claim/publish
* example: `curl -X POST -F 'name=MyPictureName' -F 'file=@/path/to/myPicture.jpeg' https://spee.ch/api/claim/publish` * example: `curl -F 'name=MyPictureName' -F 'file=@/path/to/myPicture.jpeg' https://spee.ch/api/claim/publish`
* Parameters: * Parameters:
* `name` * `name`
* `file` (must be type .mp4, .jpeg, .jpg, .gif, or .png) * `file` (must be type .mp4, .jpeg, .jpg, .gif, or .png)