Comparing version
{ | ||
"name": "wasmagic", | ||
"version": "0.0.1", | ||
"version": "0.0.2", | ||
"description": "WASM compiled version of libmagic", | ||
@@ -17,3 +17,3 @@ "keywords": [ | ||
"scripts": { | ||
"fmt": "prettier --ignore-path .gitignore -w src/**/*.ts *.js{,on} *.md", | ||
"fmt": "prettier --ignore-path .gitignore -w src/**/*.ts .github/**/*.yml *.js{,on} *.md", | ||
"test": "jest" | ||
@@ -20,0 +20,0 @@ }, |
@@ -6,4 +6,4 @@ # WASMagic | ||
A WebAssembly compiled version of [libmagic](https://www.darwinsys.com/file/) | ||
with an extremely simple API for Node. libmagic provides extremely accurate | ||
filetype detection. | ||
with a simple API for Node. WASMagic provides accurate filetype detection with | ||
zero prod dependencies. | ||
@@ -34,11 +34,24 @@ ## Usage | ||
Building requires [Emscripten](https://emscripten.org/) and autotools to be | ||
installed locally: | ||
Building requires the [Emscripten](https://emscripten.org/) sdk, autoconf, | ||
automake, and libtool. | ||
To setup for Mac: | ||
--- | ||
The easiest way to build is to use the bundled Docker builder image based on the | ||
official [Emscripten](https://hub.docker.com/r/emscripten/emsdk) image. Simply | ||
run: | ||
```bash | ||
brew install emscripten autotools | ||
make docker-builder-run test | ||
``` | ||
--- | ||
If you would like to build natively on your Mac, and have | ||
[Homebrew](https://brew.sh/) installed, install these additional packages: | ||
```bash | ||
brew install autoconf automake coreutils emscripten libtool | ||
``` | ||
Then: | ||
@@ -51,10 +64,1 @@ | ||
Will build and test the module. | ||
--- | ||
If you want to use a Docker version of | ||
[Emscripten](https://hub.docker.com/r/emscripten/emsdk), run: | ||
```bash | ||
make docker-builder-run test | ||
``` |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Mixed license
License(Experimental) Package contains multiple licenses.
Found 1 instance in 1 package
Non-permissive License
License(Experimental) A license not known to be considered permissive was found.
Found 1 instance in 1 package
0
-100%100
11.11%62
6.9%4
-20%7671366
-0.04%9
-10%5347
-0.74%