Adding readme to tar
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
Fabian Stamm 2020-07-31 19:35:18 +02:00
parent 6a4d1c3b22
commit ebc6c83f29
2 changed files with 16 additions and 2 deletions

13
tar/README.md Normal file
View File

@ -0,0 +1,13 @@
Helper functions for packing and unpacking tarfiles.
## Usage
```typescript
import { Tar } from "https://deno.hibas123.de/raw/@denreg-tar";
// The first parameter can be a file or a folder
await Tar.compress("test.txt", "test.tar");
await Tar.decompress("test.tar", ".");
```
Currently containes a version of the <https://deno.land/std/archive/tar.ts> library, but with a fix for subfolders.

View File

@ -1,12 +1,13 @@
{ {
"name": "@denreg-tar", "name": "@denreg-tar",
"version": "0.0.1", "version": "0.1.2",
"description": "Pack and Unpack tar files", "description": "Pack and Unpack tar files",
"author": "Fabian Stamm <dev@fabianstamm.de>", "author": "Fabian Stamm <dev@fabianstamm.de>",
"contributors": [], "contributors": [],
"files": [ "files": [
"**/*.ts", "**/*.ts",
"**/*.js", "**/*.js",
"importmap.json" "importmap.json",
"README.md"
] ]
} }