Merge tag 'v1.0' into debian

9 files changed, 33 insertions, 21 deletions

diff --git a/.ci/test.sh b/.ci/test.sh
index fffc883..37167ec 100755
--- a/.ci/test.sh
+++ b/.ci/test.sh
@@ -58,11 +58,11 @@ call_bin_script() {
 }
 
 call_update() {
-    call_bin_script "$script_dir/../update.sh"
+    call_bin_script "$script_dir/../links-update"
 }
 
 call_unlink() {
-    call_bin_script "$script_dir/../unlink.sh"
+    call_bin_script "$script_dir/../links-remove"
 }
 
 verify_output() {
diff --git a/README.md b/README.md
index 4cd138b..a2fc4fd 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,9 @@
-Configuration file sharing
-==========================
+Config file sharing
+===================
 
 [![Test](https://github.com/egor-tensin/config-links/actions/workflows/test.yml/badge.svg)](https://github.com/egor-tensin/config-links/actions/workflows/test.yml)
+[![Packages (Debian)](https://github.com/egor-tensin/config-links/actions/workflows/debian.yml/badge.svg)](https://github.com/egor-tensin/config-links/actions/workflows/debian.yml)
+[![Publish (Launchpad)](https://github.com/egor-tensin/config-links/actions/workflows/ppa.yml/badge.svg)](https://github.com/egor-tensin/config-links/actions/workflows/ppa.yml)
 
 * Store your files in a repository.
 * Checkout it on any machine.
@@ -22,23 +24,33 @@ corresponding symlink is then deleted too).
 The default database file name is "links.bin", maintained in the top-level
 directory with shared files.
 
-This description is obviously confusing; see the complete usage example below.
+For a complete usage example, see below.
+
+Installation
+------------
+
+* For Arch Linux, use the [AUR package].
+* For Ubuntu, use the [PPA].
+
+[AUR package]: https://aur.archlinux.org/packages/config-links/
+[PPA]: https://launchpad.net/~egor-tensin/+archive/ubuntu/config-links
 
 Usage
 -----
 
-Symlinks are managed by `update.sh`.
+Symlinks are created & maintained by `links-update`.
 
 ```
-usage: update.sh [-h|--help] [-d|--database PATH] [-s|--shared-dir DIR] [-n|--dry-run]
+usage: links-update [-h|--help] [-d|--database PATH] [-s|--shared-dir DIR] [-n|--dry-run]
 ```
 
-Pass the `--help` flag to this script to examine its detailed usage
-information.
+To remove all symlinks, use `links-remove`.
+
+```
+usage: links-remove [-h|--help] [-d|--database PATH] [-s|--shared-dir DIR] [-n|--dry-run]
+```
 
-A complete usage example is given below.
-In this example, the symlinks to files in "../src" must appear in
-"/test/dest".
+In this example, symlinks to files in "../src" must appear in "/test/dest".
 
 ```
 > tree /test/dest/
@@ -62,7 +74,7 @@ In this example, the symlinks to files in "../src" must appear in
 > echo "$DEST"
 /test/dest
 
-> ./update.sh --shared-dir ../src/
+> ./links-update --shared-dir ../src/
 ...
 
 > tree /test/dest/
@@ -78,7 +90,7 @@ In this example, the symlinks to files in "../src" must appear in
 5 directories, 2 files
 ```
 
-For more realistic usage examples, see
+For my personal real-life usage examples, see
 
 * my [Linux/Cygwin environment],
 * configuration files for various [Windows apps].
diff --git a/unlink.sh b/links-remove
index a44fa3f..271fa02 100755
--- a/unlink.sh
+++ b/links-remove
@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 # Copyright (c) 2019 Egor Tensin <Egor.Tensin@gmail.com>
-# This file is part of the "Configuration file sharing" project.
+# This file is part of the "Config file sharing" project.
 # For details, see https://github.com/egor-tensin/config-links.
 # Distributed under the MIT License.
 
diff --git a/update.sh b/links-update
index faea90d..6c3b633 100755
--- a/update.sh
+++ b/links-update
@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 # Copyright (c) 2016 Egor Tensin <Egor.Tensin@gmail.com>
-# This file is part of the "Configuration file sharing" project.
+# This file is part of the "Config file sharing" project.
 # For details, see https://github.com/egor-tensin/config-links.
 # Distributed under the MIT License.
 
diff --git a/src/common.sh b/src/common.sh
index 18df4ce..8048ae1 100644
--- a/src/common.sh
+++ b/src/common.sh
@@ -1,5 +1,5 @@
 # Copyright (c) 2016 Egor Tensin <Egor.Tensin@gmail.com>
-# This file is part of the "Configuration file sharing" project.
+# This file is part of the "Config file sharing" project.
 # For details, see https://github.com/egor-tensin/config-links.
 # Distributed under the MIT License.
 
diff --git a/src/db.sh b/src/db.sh
index 760441d..6145c6d 100644
--- a/src/db.sh
+++ b/src/db.sh
@@ -1,5 +1,5 @@
 # Copyright (c) 2016 Egor Tensin <Egor.Tensin@gmail.com>
-# This file is part of the "Configuration file sharing" project.
+# This file is part of the "Config file sharing" project.
 # For details, see https://github.com/egor-tensin/config-links.
 # Distributed under the MIT License.
 
diff --git a/src/os.sh b/src/os.sh
index f9ab7ff..2f1b4bb 100644
--- a/src/os.sh
+++ b/src/os.sh
@@ -1,5 +1,5 @@
 # Copyright (c) 2016 Egor Tensin <Egor.Tensin@gmail.com>
-# This file is part of the "Configuration file sharing" project.
+# This file is part of the "Config file sharing" project.
 # For details, see https://github.com/egor-tensin/config-links.
 # Distributed under the MIT License.
 
diff --git a/src/path.sh b/src/path.sh
index b1b1e8f..bf52a6f 100644
--- a/src/path.sh
+++ b/src/path.sh
@@ -1,5 +1,5 @@
 # Copyright (c) 2016 Egor Tensin <Egor.Tensin@gmail.com>
-# This file is part of the "Configuration file sharing" project.
+# This file is part of the "Config file sharing" project.
 # For details, see https://github.com/egor-tensin/config-links.
 # Distributed under the MIT License.
 
diff --git a/src/vars.sh b/src/vars.sh
index f989b0a..af73c1d 100644
--- a/src/vars.sh
+++ b/src/vars.sh
@@ -1,5 +1,5 @@
 # Copyright (c) 2016 Egor Tensin <Egor.Tensin@gmail.com>
-# This file is part of the "Configuration file sharing" project.
+# This file is part of the "Config file sharing" project.
 # For details, see https://github.com/egor-tensin/config-links.
 # Distributed under the MIT License.