Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

updating readme

  • Loading branch information...
commit c47dba0ffa13dad99216c556842a76ce03d19ae4 1 parent f8138fc
@ivolo authored
Showing with 12 additions and 4 deletions.
  1. +12 −4 readme.md
View
16 readme.md
@@ -21,16 +21,24 @@ It's one call, but its also one hell of a call.
### `GET /`
Returns a random ASCII animal.
+
**Parameters:**
-`index` (int) - the animal index
-If you provide the same number, you'll get the same animal.
-`offset` (int) - animal offset from the left.
+
+`index` (int) - the animal index - if you provide the same number, you'll get the same animal
+
+`offset` (int) - animal offset from the left
+
`reverse` (boolean) - specifies animal direction
-`maxheight` (int) - the maximum height an animal to return.
+
+`maxheight` (int) - the maximum height an animal to return
+
`maxwidth` (int) - the maximum width of the animal to return
+
`terminal` (boolean) - specifies whether to return the animal
+
with ANSI terminal codes that will erase the previous lines.
+
### Examples
`curl http://animals.ivolo.me/`
Please sign in to comment.
Something went wrong with that request. Please try again.