~egrajeda/arkiv

3d87eff7e6b1a760703354e188a8471515b64895 — Eduardo Grajeda 6 months ago 814d191 master
docs: update README
1 files changed, 24 insertions(+), 1 deletions(-)

M README.md
M README.md => README.md +24 -1
@@ 1,3 1,26 @@
# Arkiv

Arkiv uses [Rclone](https://rclone.org/) to mount a remote when the application starts, and shows its state as an icon in the status bar.
\ No newline at end of file
Arkiv is a Gnome app indicator which runs [rclone bisync](https://rclone.org/bisync/) in the background, and keeps you notified of any problem or action that may require your input.

For more information see [egrajeda.com/arkiv](https://egrajeda.com/arkiv).

## Installation

Run:

```
$ make
$ pipx install dist/arkiv-0.1.0.tar.gz
```

Then launch it with:

```
$ ~/.local/bin/arkiv
```

Or if you already have `~/.local/bin` on your `PATH`, you can do:

```
$ arkiv
```
\ No newline at end of file