Permalink
Browse files

readme

  • Loading branch information...
1 parent 26dd309 commit 989573f4ff6a259fd570a0dd4dc81474cabedb35 @dvv committed Feb 1, 2012
Showing with 17 additions and 9 deletions.
  1. +2 −1 Makefile
  2. +15 −8 README.md
View
@@ -4,7 +4,8 @@ module:
$(MAKE) -C zlib
clean:
- rm -fr tmp zlib/build
+ rm -fr tmp
+ $(MAKE) -C zlib clean
test: module
checkit tests/buffer.lua tests/inflate.lua
View
@@ -1,15 +1,22 @@
+Balls
+=====
+
+Collection of helpers to deal with zipballs
+
Usage
-----
- -- import
- local unzip = require('balls').unzip
+```lua
+-- import
+local unzip = require('balls').unzip
- -- unzip zipball 'foo.zip' into ./foo/zip
- unzip('foo.zip', 'foo/zip', function(err)
- print('DONE', err)
- end)
+-- unzip zipball 'foo.zip' into ./foo/zip
+unzip('foo.zip', { path = 'foo/zip' }, function(err)
+ print('DONE', err)
+end)
+```
License
--------
+-----
-Check [here](license.txt).
+[MIT](luvit-balls.txt)

0 comments on commit 989573f

Please sign in to comment.