aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorOmar Rizwan <omar.rizwan@gmail.com>2020-10-29 23:54:40 -0700
committerOmar Rizwan <omar.rizwan@gmail.com>2020-10-29 23:54:40 -0700
commit140bd127dfc379955f28e3477909a65b25e0f928 (patch)
treeef75e137b066d65d37279bb00f2de0b1bf904a17 /README.md
parentf576b4c324d3c9a9a4fe2fc9ef60dc34427df1bc (diff)
Specify extension id in install.sh & check usage. Improve README.
Diffstat (limited to 'README.md')
-rw-r--r--README.md62
1 files changed, 51 insertions, 11 deletions
diff --git a/README.md b/README.md
index 7f152cb..ec5fd02 100644
--- a/README.md
+++ b/README.md
@@ -2,10 +2,28 @@
## Setup
-You need to compile the FUSE filesystem (written in C), then install
-the browser extension which runs it and talks to it.
+First, install the browser extension.
-### Run the C filesystem
+Then, install the C filesystem.
+
+### Install the browser extension
+
+(I think it will work on Edge or Opera or whatever, too. You'll need to
+change the native messaging path in install.sh in those cases.)
+
+#### Chrome
+
+Go to the [Chrome extensions page](chrome://extensions). Enable
+Developer mode (top-right corner).
+
+Load-unpacked the `extension/` folder in this repo.
+
+Get the extension ID.
+
+#### Firefox
+
+
+### Install the C filesystem
First, make sure you `git submodule update --init` to get the
`fs/cJSON` and `fs/base64` dependencies.
@@ -26,20 +44,42 @@ extension can launch and talk to the filesystem:
$ ./install.sh [chrome | chromium | firefox]
```
-### Install the browser extension
+### Ready
-I think it will work on Edge or Opera or whatever, too. You'll need to
-change the native messaging path in install.sh
+Reload the extension in `chrome://extensions`.
-#### Firefox
+Now your browser tabs should be mounted in `fs/mnt`!
-#### Chrome
+## Examples of stuff you can do
-Go to the [Chrome extensions page](chrome://extensions).
+(assuming your shell is in the `fs` subdirectory)
-Enable Developer mode. Load-unpacked the `extension/` folder in this repo.
+### List the titles of all the tabs you have open
-Now your browser tabs should be mounted in `fs/mnt`!
+```
+$ cat mnt/tabs/by-id/*/title
+GitHub
+Extensions
+TabFS/install.sh at master ยท osnr/TabFS
+Alternative Extension Distribution Options - Google Chrome
+Web Store Hosting and Updating - Google Chrome
+Home / Twitter
+...
+```
+
+### Close all Stack Overflow tabs
+
+```
+$ echo close | tee -a mnt/tabs/by-title/*Stack_Overflow*/control
+```
+
+### Save text of all tabs to a file
+
+(wip, FIXME)
+
+```
+$ cat mnt/tabs/by-id/*/text > text.txt
+```
## Design