From c38470ecccc8f70aad5cd03373afa7a33addc180 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Mart=C3=AD?= Date: Sat, 9 Jun 2018 22:45:43 +0100 Subject: [PATCH] README: update with recent changes and simplify --- README.md | 44 +++++++++++++++++++------------------------- 1 file changed, 19 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 5ba00a8..f82f467 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,8 @@ go get -u mvdan.cc/fdroidcl/cmd/fdroidcl -This is **not** a replacement for the [Android client](https://gitlab.com/fdroid/fdroidclient). - While the Android client integrates with the system with regular update checks -and notifications, this is a command line client that talks to connected +and notifications, this is a simple command line client that talks to connected devices via [ADB](https://developer.android.com/tools/help/adb.html). ### Quickstart @@ -34,38 +32,34 @@ Install an app: show Show detailed info about an app devices List connected devices download Download an app - install Install an app - upgrade Upgrade an app + install Install or upgrade app uninstall Uninstall an app defaults Reset to the default settings - A specific version of an app can be selected by following the appid with an colon (:) and the version code of the app to select. +A specific version of an app can be selected by following the appid with an +colon (:) and the version code of the app to select. ### Config -You can configure the repositories to use in the `config.json` file, -located in `fdroidcl`'s config directory. This will be -`~/.config/fdroidcl/config.json` on Linux. - -You can run `fdroidcl defaults` to create the config with the default -settings. - -### Missing features +You can configure what repositories to use in the `config.json` file. On Linux, +you will likely find it at `~/.config/fdroidcl/config.json`. - * Index verification via jar signature - currently relies on HTTPS - * Interaction with multiple devices at once - * Hardware features filtering +You can run `fdroidcl defaults` to create the config with the default settings. ### Advantages over the Android client - * Command line interface - * Batch install/update/remove apps without root nor system privileges - * Handle multiple Android devices - * No need to install a client on the device +* Command line interface +* Batch install/update/remove apps without root nor system privileges +* No need to install a client on the device ### What it will never do - * Run as a daemon, e.g. periodic index updates - * Graphical user interface - * Act as an F-Droid server - * Swap apps with devices running the Android client +* Run as a daemon, e.g. periodic index updates +* Act as an F-Droid server +* Swap apps with devices + +### Caveats + +* Index verification relies on HTTPS (not the JAR signature) +* The tool can only interact with one device at a time +* Hardware compatibility of packages is not checked