branch: externals/bluetooth
commit 9d1369a3b729f0f37e326f5de13cfa61ad8589c3
Author: Raffael Stocker <r.stoc...@mnet-mail.de>
Commit: Raffael Stocker <r.stoc...@mnet-mail.de>
adds Readme.org and removes Readme.md
---
README.md | 3 ---
Readme.org | 24 ++++++++++++++++++++++++
2 files changed, 24 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
deleted file mode 100644
index fa48946..0000000
--- a/README.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# emacs-bluetooth
-
-Manage Bluetooth devices using GNU Emacs
\ No newline at end of file
diff --git a/Readme.org b/Readme.org
new file mode 100644
index 0000000..9b090d6
--- /dev/null
+++ b/Readme.org
@@ -0,0 +1,24 @@
+* Emacs Bluetooth Mode
+
+ This package provides a simple Bluetooth mode that can be used to manage
+ Bluetooth devices on GNU/Linux using GNU Emacs.
+
+ Implemented features are:
+ - (un-)pairing devices
+ - (dis-)connecting
+ - discovery mode
+ - setting device properties (alias, blocked, trusted)
+ - setting adapter properties (powered, discoverable, pairable)
+
+ The implementation is based on the Bluez DBus interface (see
+ [[https://www.bluez.org]]).
+
+** Usage
+
+ To use it, put ~bluetooth.el~ somewhere in your load path, include
+ #+begin_src emacs-lisp
+ (require 'bluetooth)
+ #+end_src
+ in ~init.el~ and call ~list-bluetooth-devices~. No configuration is
+ necessary or possible. Use ~describe-mode~ (usually "C-h m") to get a list
+ of key bindings.
