@@ -1,29 +1,26 @@
1−## obelisk-asset
1+# obelisk-asset
22
3−The 'assets.nix' file contains nix expressions that are a mutually
4−recursive set of attributes used to create static asset directories
5−with hashable file encodings. This file should be incorporated within
6−your project's 'default.nix' file. (See ./example/default.nix , line 2)
7−```
8−{assets ? import ./../assets.nix { inherit nixpkgs; }
9−}:
10−```
3+[](http://www.haskell.org)
4+[](https://github.com/obsidiansystems/obelisk/blob/master/LICENSE)
115
12−The 'mkAssets' and 'mkAssetsWith' functions within 'assets.nix' only
13−need to be passed an encoding('zopfliEncodings', 'gzipEncodings',
14−'noEncodings') and a static directory of your choice as arguments.
6+**Efficiently served, aggressively cached static web resources.**
157
16−In this example, 'mkAssets' is used on a directory that has a .png
17−file inside of it. (See ./example/default.nix, line 11)
8+The `assets.nix` file contains nix expressions that are a mutually recursive set of attributes used to create static asset directories with hashable file encodings. This file should be incorporated within your project's `default.nix` file. (See `example/default.nix`, line 2)
9+
10+```nix
11+{ assets ? import ./../assets.nix { inherit nixpkgs; } }:
1812```
13+
14+The `mkAssets` and `mkAssetsWith` functions within `assets.nix` only need to be passed an `encoding("zopfliEncodings", "gzipEncodings", "noEncodings")` and a static directory of your choice as arguments.
15+
16+In this example, `mkAssets` is used on a directory that has a `.png` file inside of it. (See `example/default.nix`, line 11)
17+
18+```nix
1919myAssets = assets.mkAssets ./static;
2020```
2121
22−Once you have successfully incorporated 'assets.nix' into your
23−project's nix file(s), use nix-build to generate a symlink of
24−your 'mkAssets' expression. The following command from
25−example/run-example (line 3) will generate an immutable symlink
26−that holds hashed static assets.
22+Once you have successfully incorporated `assets.nix` into your project's nix file(s), use `nix-build` to generate a symlink of your `mkAssets` expression. The following command from `example/run-example` (line 3) will generate an immutable symlink that holds hashed static assets.
23+
2724```bash
2825nix-build -o static.assets -A myAssets
2926```