From 7da452011fc45bf4aaa867b5fb61e71462dc12e3 Mon Sep 17 00:00:00 2001 From: Thomas Dickson Date: Tue, 24 Dec 2024 14:31:24 +1300 Subject: [PATCH] docs: add changes into README --- README.md | 48 +++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 39 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 861e623..6eb3be3 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Unofficial packages are available on: ## Commands -```sh +```text update Update the index search [] Search available apps show Show detailed info about apps @@ -53,8 +53,10 @@ Unofficial packages are available on: uninstall Uninstall an app download Download an app devices List connected devices + scan Scan for known fdroid apps on a device list (categories/users) List all known values of a kind repo Manage repositories + setups Manage setups clean Clean index and/or cache defaults Reset to the default settings version Print version information @@ -70,16 +72,9 @@ be selected by following the appid with a colon and the version code. The fdroidcl install org.quantumbadger.redreader:85 ``` -## Config - -You can configure what repositories to use in the `config.json` file. On Linux, -you will likely find it at `~/.config/fdroidcl/config.json`. - -You can run `fdroidcl defaults` to create the config with the default settings. - ### *new: you can manage the repositories now directly via cli* -```sh +```text usage: fdroidcl repo List, add, remove, enable or disable repositories. @@ -97,6 +92,41 @@ Modify repositories: $ fdroidcl repo disable ``` +### *new: you can manage automating installs using setups* + +```text +usage: fdroidcl setup + +List, add, remove, edit, and import/export setups. +Setups allow for mass installs onto an android device, excellent for backups. + +List setups: + + $ fdroidcl setup Show all setups + $ fdroidcl setup list Show details about one setup + +Modify setups: + $ fdroidcl setup new + $ fdroidcl setup remove + $ fdroidcl setup apply + $ fdroidcl setup add-app + $ fdroidcl setup rm-app + $ fdroidcl setup add-repo + $ fdroidcl setup rm-repo + +Export setups: + + $ fdroidcl setup import + $ fdroidcl setup export +``` + +## Config + +You can configure what repositories to use in the `config.toml` file. On Linux, +you will likely find it at `~/.config/fdroidcl/config.toml`. + +You can run `fdroidcl defaults` to create the config with the default settings. + ## Advantages over the Android client * Command line interface