diff --git a/extractFile.md b/extractFile.md index cc9cc2d..7e5f117 100644 --- a/extractFile.md +++ b/extractFile.md @@ -1,4 +1,4 @@ -The Function `extractFile` contains 4 Parameters. +The `extractFile` function has 4 parameters. It extracts files matching a regexp from an archive. `file` -> The Path to the Archive. @@ -8,25 +8,25 @@ The Function `extractFile` contains 4 Parameters. `message` -> Message while extracting. -You can find an example for a folder here: +Example for extracting a folder: ```json - { - "type": "extractFile", - "file": "/Spritesheets.zip", - "input": "", - "output": "/LeafEdit/", - "message": "Extracting SpriteSheets... please wait." - } +{ + "type": "extractFile", + "file": "/Spritesheets.zip", + "input": "", + "output": "/LeafEdit/", + "message": "Extracting SpriteSheets... please wait." +} ``` -*Note that the output folders **must** end in a `/`* +*Note that the output folders **must** end in a `/`* -and an example for a file here: +Example for extracting a file: ```json - { - "type": "extractFile", - "file": "/LeafEdit.7z", - "input": "LeafEdit.3dsx", - "output": "/3ds/LeafEdit.3dsx", - "message": "Extracting SpriteSheets... please wait." - } +{ + "type": "extractFile", + "file": "/LeafEdit.7z", + "input": "LeafEdit.3dsx", + "output": "/3ds/LeafEdit.3dsx", + "message": "Extracting SpriteSheets... please wait." +} ``` \ No newline at end of file