Permalink
Browse files

updating readme

  • Loading branch information...
1 parent 0eedb93 commit ee21d0afe85167595b748d4d0e1cc4c96e23a50c @ivolo committed Aug 19, 2012
Showing with 28 additions and 6 deletions.
  1. +28 −6 readme.md
View
@@ -5,16 +5,38 @@
Loading indicator innovation. Enterprise loading solutions. Synergy.
Animal Meetspace.
-## Try it:
+```
+ .'"'. ___,,,___ .'``.
+: (\ `."'"``` ```"'"-' /) ;
+ : \ `./ .'
+ `. :.'
+ / _ _ \
+ | 0} {0 |
+ | / \ |
+ | / \ |
+ | / \ |
+ \ | .-. | /
+ `. | . . / \ . . | .'
+ `-._\.'.( ).'./_.-'
+ `\' `._.' '/'
+ `. --'-- .'
+ `-...-'
+
+```
+
+## Try it yourself:
```bash
curl -s https://raw.github.com/ivolo/animals/master/examples/loading.sh | sh
```
```bash
+pip install requests
curl -s https://raw.github.com/ivolo/animals/master/examples/loading.py | python
```
+Please contain your excitement.
+
## REST API
It's one call, but its also one hell of a call.
@@ -24,17 +46,17 @@ Returns a random ASCII animal.
**Parameters:**
-`index` (int) - the animal index - if you provide the same number, you'll get the same animal
+`index` (int) - give it the same number, get the same animal. we have around 600 animals.
-`offset` (int) - animal offset from the left
+`offset` (int) - space offset from the left
-`reverse` (boolean) - specifies animal direction
+`reverse` (boolean) - reversed or not
`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.
+`terminal` (boolean) - whether to return the animal with ANSI terminal codes that will erase the previous lines.
### Examples
@@ -87,7 +109,7 @@ Returns a random ASCII animal.
[Python](https://github.com/ivolo/animals/blob/master/examples/loading.py)
-[Shell](https://github.com/ivolo/animals/blob/master/examples/loading.shell)
+[Shell](https://github.com/ivolo/animals/blob/master/examples/loading.sh)
## Host Your Own
Availability is crucial when dealing with ascii animal web services,

0 comments on commit ee21d0a

Please sign in to comment.