Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Adding usage example

  • Loading branch information...
commit 2e68d2ef2e3b0ffadc88c29414db3b63005e7748 1 parent 2714f82
Graham Ranson authored November 24, 2012

Showing 1 changed file with 35 additions and 2 deletions. Show diff stats Hide diff stats

  1. 37  README.md
37  README.md
Source Rendered
... ...
@@ -1,4 +1,37 @@
1 1
 GGTar
2  
-=====
  2
+============
3 3
 
4  
-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
  4
+This is a GGified version of the Tar module for the LuaRocks project provided 
  5
+here - https://github.com/keplerproject/luarocks/blob/master/src/luarocks/tools/tar.lua
  6
+
  7
+Basic Usage
  8
+-------------------------
  9
+
  10
+##### Require The Code
  11
+```lua
  12
+local GGTar = require( "GGTar" )
  13
+```
  14
+
  15
+##### Create your GGTar object
  16
+```lua
  17
+local tar = GGTar:new()
  18
+```
  19
+
  20
+##### Untar an archive in the temp directory into the documents directory and call a function when done.
  21
+```lua
  22
+local onComplete = function()
  23
+	print( "All done!" )
  24
+end
  25
+tar:untar( "level1.tar", system.DocumentsDirectory, system.TemporaryDirectory, onComplete )
  26
+```
  27
+
  28
+##### Destroy this GGTar object
  29
+```lua
  30
+tar:destroy()
  31
+```
  32
+
  33
+Update History
  34
+-------------------------
  35
+
  36
+##### 0.1
  37
+Initial release

0 notes on commit 2e68d2e

Please sign in to comment.
Something went wrong with that request. Please try again.