@@ -0,0 +1,15 @@
1+# GHCJS-optimizer
2+
3+This is a simple nix wrapper that optimizes the js with [Google Closure Compiler](https://github.com/google/closure-compiler) and compresses text files with [zopfli](https://github.com/google/zopfli).
4+
5+This is very simple and intended for a pretty narrow use case: it is intended for use with [haskell.nix](https://github.com/input-output-hk/haskell.nix) (but will probably work with other nix builders). It also only uses the `all.js` file, since it allows more room for optimization, and having one file in most cases will be better than loading multiple. This means that the default `index.html` generated by the stock builder will not work. I replace `index.html` with one that only uses `all.js`.
6+
7+## Example
8+
9+```nix
10+let ghcjs-optimizer = import ../ghcjs-optimizer { pkgs = nixpkgs; };
11+ in ghcjs-optimizer hsPkgs.projectCross.ghcjs.hsPkgs.<your project>.components.exes.<your executable>;
12+```
13+
14+
15+I suggest you use [niv](https://github.com/nmattia/niv) for nix dependencies like this.