From ebc6c83f293314786264beeda10f37da8b75049d Mon Sep 17 00:00:00 2001 From: Fabian Stamm Date: Fri, 31 Jul 2020 19:35:18 +0200 Subject: [PATCH] Adding readme to tar --- tar/README.md | 13 +++++++++++++ tar/meta.json | 5 +++-- 2 files changed, 16 insertions(+), 2 deletions(-) create mode 100644 tar/README.md diff --git a/tar/README.md b/tar/README.md new file mode 100644 index 0000000..a181212 --- /dev/null +++ b/tar/README.md @@ -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 library, but with a fix for subfolders. diff --git a/tar/meta.json b/tar/meta.json index cd93559..b9a21fc 100644 --- a/tar/meta.json +++ b/tar/meta.json @@ -1,12 +1,13 @@ { "name": "@denreg-tar", - "version": "0.0.1", + "version": "0.1.2", "description": "Pack and Unpack tar files", "author": "Fabian Stamm ", "contributors": [], "files": [ "**/*.ts", "**/*.js", - "importmap.json" + "importmap.json", + "README.md" ] } \ No newline at end of file