README: Update documentation source

darkhz · Sep 1, 2023 · eab3f27 · eab3f27
1 parent 0cb2efc
commit eab3f27
Showing 1 changed file with 3 additions and 118 deletions.
diff --git a/README.md b/README.md
@@ -19,122 +19,7 @@ This project is currently in the alpha stage.
 - Remotely control media playback on the connected device
 - Mouse support
 
-## Requirements
-- Bluez
-- DBus
-- NetworkManager (optional, required for PANU)
-- ModemManager (optional, required for DUN)
-- PulseAudio (optional, required to manage device audio profiles)
+## Documentation
+The documentation is now hosted [here](https://bluetuith.darkhz.io)
 
-## Installation
-If the `go` compiler is present in your system, you can install it via the following command:
-`go install github.com/darkhz/bluetuith@latest`
-
-Or you can navigate to the releases section and download a binary that matches your architecture.
-
-It is also available in the AUR as bluetuith-bin.
-
-## Usage
-    bluetuith [<flags>]
-
-    Flags:
-      --adapter <adapter>          Specify an adapter to use. (For example, hci0)
-      --gsm-apn <apn>              Specify GSM APN to connect to. (Required for DUN)
-      --gsm-number <number>        Specify GSM number to dial. (Required for DUN)
-      --list-adapters              List available adapters.
-      --receive-dir <dir>          Specify a directory to store received files.
-      --set-theme <theme>          Specify a theme
-      --set-theme-config <config>  Specify a comma-separated list of modifier-color pairs.
-
-- To use DUN-based networking, it is required to specify the **gsm-number** option. The **gsm-apn** field is optional.
-
-- If the **receive-dir** option is not specified, received files will be stored in ``$HOME/bluetuith``.
-
-- For more information on how to use the **set-theme** and **set-theme-config** options,
-navigate to the [Themes](https://github.com/darkhz/bluetuith/wiki/Themes) wiki page.
-
-## Configuration
-bluetuith should generally work out-of-the-box, with no required configurations.
-
-If persistent configuration for certain settings is required, a config file can be used.<br />
-The config file is automatically created on startup, and its location can be viewed on invoking ``bluetuith --help``.
-
-Configuration properties can be in the form of a simple ``name=value``or ``name value`` pair.
-
-For example:
-
-    adapter=hci0
-    receive-dir=/home/darkhz/bluetuith
-
-## Keybindings
-
-### Device Screen
-|Operation                       |Keybinding                   |
-|--------------------------------|-----------------------------|
-|Open the menu                   |<kbd>Ctrl</kbd>+<kbd>m</kbd> |
-|Navigate between menus          |<kbd>Tab</kbd>               |
-|Navigate between devices/options|<kbd>Up</kbd>/<kbd>Down</kbd>|
-|Toggle adapter power state      |<kbd>o</kbd>                 |
-|Toggle discoverable state       |<kbd>S</kbd>                 |
-|Toggle pairable state           |<kbd>P</kbd>                 |
-|Toggle scan (discovery state)   |<kbd>s</kbd>                 |
-|Change adapter                  |<kbd>a</kbd>                 |
-|Send files                      |<kbd>f</kbd>                 |
-|Connect to network              |<kbd>n</kbd>                 |
-|Progress view                   |<kbd>v</kbd>                 |
-|Connect to selected device      |<kbd>c</kbd>                 |
-|Pair with selected device       |<kbd>p</kbd>                 |
-|Trust selected device           |<kbd>t</kbd>                 |
-|Show media player               |<kbd>m</kbd>                 |
-|Hide media player               |<kbd>M</kbd>                 |
-|Show device information         |<kbd>i</kbd>                 |
-|Remove device from adapter      |<kbd>d</kbd>                 |
-|Cancel operation                |<kbd>Ctrl</kbd>+<kbd>x</kbd> |
-|Quit                            |<kbd>q</kbd>                 |
-
-### File Picker
-|Operation                         |Keybinding                    |
-|----------------------------------|------------------------------|
-|Navigate between directory entries|<kbd>Up</kbd>/<kbd>Down</kbd> |
-|Enter a directory                 |<kbd>Right</kbd>              |
-|Go back one directory             |<kbd>Left</kbd>               |
-|Select one file                   |<kbd>Space</kbd>              |
-|Invert file selection             |<kbd>a</kbd>                  |
-|Select all files                  |<kbd>A</kbd>                  |
-|Refresh current directory         |<kbd>Ctrl</kbd> + <kbd>r</kbd>|
-|Toggle hidden files               |<kbd>Ctrl</kbd>+<kbd>h</kbd>  |
-|Confirm file(s) selection         |<kbd>Ctrl</kbd>+<kbd>s</kbd>  |
-|Exit                              |<kbd>Escape</kbd>             |
-
-### Progress View
-|Operation                 |Keybinding                   |
-|--------------------------|-----------------------------|
-|Navigate between transfers|<kbd>Up</kbd>/<kbd>Down</kbd>|
-|Suspend transfer          |<kbd>z</kbd>                 |
-|Resume transfer           |<kbd>g</kbd>                 |
-|Cancel transfer           |<kbd>x</kbd>                 |
-|Exit                      |<kbd>Escape</kbd>            |
-
-### Media Player
-|Operation        |Keybinding      |
-|-----------------|----------------|
-|Toggle play/pause|<kbd>Space</kbd>|
-|Next             |<kbd>></kbd>    |
-|Previous         |<kbd><</kbd>    |
-|Rewind           |<kbd>Left</kbd> |
-|Fast forward     |<kbd>Right</kbd>|
-|Stop             |<kbd>]</kbd>    |
-
-## Planned features
- - [x] OBEX file transfer.
- - [x] Display the device type and icon.
- - [x] Display range (RSSI) of the connected device.
-
-## Additional notes
-- Ensure that the bluetooth service is up and running, and it is visible to DBus before launching the application. With systemd you can find out the status using the following command: `systemctl status bluetooth.service`.
-- Only one transfer (either of send or receive) can happen on an adapter. Attempts to start another transfer while a transfer is already running (for example, trying to send files to a device when a transfer is already in progress) will be silently ignored.
-
-## Credits
-Special thanks to:
-- **vishen**, for the bluez implementation [here](https://github.com/vishen/sluez/blob/master/bluez/device.go).
-- **muka**, for the agent implementation [here](https://github.com/muka/go-bluetooth/blob/master/bluez/profile/agent/agent_simple.go).
+The wiki is out-of-date.