Permalink
Browse files

Adding usage example

  • Loading branch information...
1 parent 2714f82 commit 2e68d2ef2e3b0ffadc88c29414db3b63005e7748 @GrahamRanson GrahamRanson committed Nov 24, 2012
Showing with 35 additions and 2 deletions.
  1. +35 −2 README.md
View
@@ -1,4 +1,37 @@
GGTar
-=====
+============
-This is a GGified version of the Tar module for the LuaRocks project provided here - https://github.com/keplerproject/luarocks/blob/master/src/luarocks/tools/tar.lua
+This is a GGified version of the Tar module for the LuaRocks project provided
+here - https://github.com/keplerproject/luarocks/blob/master/src/luarocks/tools/tar.lua
+
+Basic Usage
+-------------------------
+
+##### Require The Code
+```lua
+local GGTar = require( "GGTar" )
+```
+
+##### Create your GGTar object
+```lua
+local tar = GGTar:new()
+```
+
+##### Untar an archive in the temp directory into the documents directory and call a function when done.
+```lua
+local onComplete = function()
+ print( "All done!" )
+end
+tar:untar( "level1.tar", system.DocumentsDirectory, system.TemporaryDirectory, onComplete )
+```
+
+##### Destroy this GGTar object
+```lua
+tar:destroy()
+```
+
+Update History
+-------------------------
+
+##### 0.1
+Initial release

0 comments on commit 2e68d2e

Please sign in to comment.