Initial commit (no more AUR-only weirdness)

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Brayden Banks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,75 @@
+# betterdiscordctl
+
+A utility for managing BetterDiscord on Linux. Requires NodeJS and Git to be installed.
+
+To completely remove `betterdiscordctl`'s local data, delete
+`$XDG_DATA_HOME/betterdiscordctl`.
+
+## Commands
+
+### `status` (default)
+
+Displays information about your current BetterDiscord setup.
+
+### `install`
+
+Installs BetterDiscord, managing what's necessary by default.
+
+### `update`
+
+Updates BetterDiscord, updating your local repository if present (`origin`
+branch).
+
+(Advanced users should avoid using this if locally modifying their linked
+repositories, and should instead manually fetch and update.)
+
+### `uninstall`
+
+Uninstalls BetterDiscord, removing the managed repository if used.
+
+## Flags
+
+### `-h` / `--help`
+
+Displays usage information.
+
+### `-v` / `--verbose`
+
+Increases the verbosity level, for progressively more debugging information.
+
+### `-s` / `--scan` (default `/opt`)
+
+Changes the directory scanned for Discord installations.
+
+### `-f` / `--flavors` (default `,Canary,PTB`)
+
+When scanning, looks for installations with the given suffixes (both hyphenated
+and unhyphenated).
+
+### `-d` / `--discord` (requires `--modules`)
+
+Skip scanning and use the Discord installation directory specified.
+
+### `-m` / `--modules`
+
+Disregards scanning results and uses the specified modules directory (found
+inside Discord's user-specific storage directory).
+
+### `-r` / `--bd-repo` (default `https://github.com/rauenzi/BetterDiscordApp`)
+
+When initially installing BetterDiscord, use the specified Git repository. Does
+_not_ affect updates. Defaults to Zerebos's BandagedBD fork.
+
+### `-b` / `--betterdiscord`
+
+Instead of maintaining a local clone of BetterDiscord, use the specified
+directory.
+
+### `-c` / `--copy-bd`
+
+Instead of using a symbolic link, copy the BetterDiscord directory into
+Discord's modules.
+
+### `--global-asar`
+
+Instead of maintaining a local installation of `asar`, use the one in `PATH`.