diff --git a/README.md b/README.md index 6db2c201..5410dc60 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,14 @@ example: ``` curl https://spee.ch/api/claim/availability/doitlive ``` -returns the name if it is available +response: +``` +{ + "success": , // `true` if spee.ch succesfully checked the claim availability + "data": , // `true` if claim is available, false if it is not available + "message": // human readable message of whether claim was available or not +} +``` ## Contribute