diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss index f5e0656..35227bc 100644 --- a/docs/assets/css/style.scss +++ b/docs/assets/css/style.scss @@ -10,3 +10,5 @@ #download-linux span { background:transparent url(../images/linux-icon.png) 12px 50% no-repeat } + +iframe { width: 100%; } diff --git a/docs/index.md b/docs/index.md index be02b26..942dc55 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,6 +13,8 @@ data, like JSON or YAML. These semi-structured formats are essentially trees, and string processing is a bad match---editing JSON with sed is not a very good idea! +![Demo of in-place editing, starting from an empty JSON object to building up a compound one; transcript is below](assets/images/inplace_demo.gif) + ffs---short for the **f**ile **f**ile**s**ystem---lets you mount semi-structured data as a filesystem, letting you work with modern formats using your familiar shell tools. @@ -25,7 +27,7 @@ You can read more about it in [the `ffs` manpage](ffs.1.html). # Examples -![Demo of in-place editing, starting from an empty JSON object to building up a compound one; transcript is below](assets/images/inplace_demo.gif) + Run `ffs [file]` to mount `file.blah` at the mountpoint `file`. The final, updated version of the file will be outputted on stdout. @@ -103,6 +105,15 @@ See the [release page](https://github.com/mgree/ffs/releases) for particular releases; the current version is 0.1.2. You can also build ffs from [source](https://github.com/mgree/ffs). +# Learn more + +Check out the paper ["Files-as-Filesystems for POSIX Shell Data +Processing"](https://dl.acm.org/doi/10.1145/3477113.3487265) from +[PLOS 2021](https://plos-workshop.org/2021/). The pre-recorded demo is +above; the pre-recorded talk is below. + + + # Related tools Tools like [jq](https://stedolan.github.io/jq/) and