Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nika-begiashvili committed Jul 19, 2019
1 parent 03e5a93 commit cc9ab5f
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

## Overview

Libarchivejs is a archive tool for browser which can extract various types of compression, it's port of [libarchive](https://github.com/libarchive/libarchive) to WebAssembly and javascript wrapper to make it easier to use, since it runs on WebAssembly performance should be near native. supported formats: **ZIP**, **7-Zip**, **GZIP**, **RAR v4**, **TAR** and more
Libarchivejs is a archive tool for browser which can extract various types of compression, it's port of [libarchive](https://github.com/libarchive/libarchive) to WebAssembly and javascript wrapper to make it easier to use, since it runs on WebAssembly performance should be near native. supported formats: **ZIP**, **7-Zip**, **RAR v4**, **RAR v5**, **TAR**. supported compression: **GZIP**, **DEFLATE**, **BZIP2**, **LZMA**

## How to use

Expand Down Expand Up @@ -98,6 +98,16 @@ To extract single file from archive you can use `extract()` method on returned `
const file = await filesObj['.gitignore'].extract();
```

### Check for encrypted data

```js
const archive = await Archive.open(file);
await archive.hasEncryptedData();
// true - yes
// false - no
// null - can not be determined
```

## How it works

Libarchivejs is port of popular [libarchive](https://github.com/libarchive/libarchive) C library to WASM. since WASM runs in current thread library uses WebWorkers for heavy lifting, ES Module (Archive class) is just a client for WebWorker, it's tiny and doesn't take up much space.
Expand Down

0 comments on commit cc9ab5f

Please sign in to comment.