From 059684e0b02a6ca7191bc3d4b12edd83a30b96ad Mon Sep 17 00:00:00 2001 From: Bill Bittner Date: Thu, 8 Mar 2018 09:34:23 -0800 Subject: [PATCH] Update README.md --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 33aee954..191a1383 100644 --- a/README.md +++ b/README.md @@ -30,19 +30,19 @@ Spee.ch is a web app that reads and publishes images and videos to and from the #### GET * /api/claim/resolve/:name/:claimId - * example: `curl https://spee.ch/api/claim/resolve/doitlive/xyz` + * example: `curl https://spee.ch/api/claim/resolve/doitlive/xyz` * /api/claim/list/:name - * example: `curl https://spee.ch/api/claim/list/doitlive` -* /api/claim/availability/:name ( - * returns `true`/`false` for whether a name is available through spee.ch - * example: `curl https://spee.ch/api/claim/availability/doitlive` -* /api/channel/availability/:name ( - * returns `true`/`false` for whether a channel is available through spee.ch - * example: `curl https://spee.ch/api/channel/availability/@CoolChannel` + * example: `curl https://spee.ch/api/claim/list/doitlive` +* /api/claim/availability/:name + * returns the name if it is available + * example: `curl https://spee.ch/api/claim/availability/doitlive` +* /api/channel/availability/:name + * returns the name if it is available + * example: `curl https://spee.ch/api/channel/availability/@CoolChannel` #### POST * /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: * `name` * `file` (must be type .mp4, .jpeg, .jpg, .gif, or .png)