Skip to content

Commit

Permalink
add browser version and more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
drbh committed May 8, 2019
1 parent 977ec65 commit 021d046
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 15 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "wasm-flate"
version = "0.1.9-alpha"
version = "0.1.11-alpha"
authors = ["David Holtz <david.richard.holtz@gmail.com>"]
edition = "2018"

Expand Down
33 changes: 19 additions & 14 deletions DOCS.md
Expand Up @@ -11,60 +11,65 @@ var flate = require('wasm-flate');
```

## Using in Browser

Just load the following script tag into your html page. You should have access to flate in the console now.
```html
<script src="https://unpkg.com/wasm-flate@0.1.11-alpha/dist/bootstrap.js"></script>
```
..coming soon..
```

![console](https://raw.githubusercontent.com/drbh/wasm-flate/master/images/console.png)


## Functions

### base64 input and output
```
```javascript
flate.deflate_decode( base64EncodedString )
returns base64EncodedString
```
```
```javascript
flate.deflate_encode( base64EncodedString )
returns base64EncodedString
```
```
```javascript
flate.gzip_decode( base64EncodedString )
returns base64EncodedString
```
```
```javascript
flate.gzip_encode( base64EncodedString )
returns base64EncodedString
```
```
```javascript
flate.zlib_decode( base64EncodedString )
returns base64EncodedString
```
```
```javascript
flate.zlib_encode( base64EncodedString )
returns base64EncodedString
```

#### u8intArray input and output
```
```javascript
flate.deflate_decode_raw( u8intArray )
returns u8intArray
```
```
```javascript
flate.deflate_encode_raw( u8intArray )
returns u8intArray
```
```
```javascript
flate.gzip_decode_raw( u8intArray )
returns u8intArray
```
```
```javascript
flate.gzip_encode_raw( u8intArray )
returns u8intArray
```
```
```javascript
flate.zlib_decode_raw( u8intArray )
returns u8intArray
```
```
```javascript
flate.zlib_encode_raw( u8intArray )
returns u8intArray
```
8 changes: 8 additions & 0 deletions README.md
Expand Up @@ -111,6 +111,14 @@ var decomp = flate.deflate_decode_raw(comp)
JSON.stringify(data) === JSON.stringify(decomp)
```

## Example Browser Usage

Just load the following script tag into your html page. You should have access to flate in the console now.
```html
<script src="https://unpkg.com/wasm-flate@0.1.11-alpha/dist/bootstrap.js"></script>
```


# Building with Rust 🦀🕸️

In order to build the wasm files with Rust, you'll need to clone the repo and run `wasm-pack` with `nodejs` as the target. This will create a set of files in `pkg` that can be used as a node module.
Expand Down
Binary file added images/console.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 021d046

Please sign in to comment.