summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRomeo Disca <romeo.disca@gmail.com>2020-08-21 21:57:54 +0200
committerRomeo Disca <romeo.disca@gmail.com>2020-08-21 22:01:10 +0200
commitd74b1fc9baa8db72ed3d5e79c0a50a09d31de988 (patch)
treef7dbb2bedeedfcb87e23e99f7191e5a276d9ac4c
parentffa296117d9f5820730acb83ac6d6771a61cefd8 (diff)
downloadflicbtn-d74b1fc9baa8db72ed3d5e79c0a50a09d31de988.tar.gz
flicbtn-d74b1fc9baa8db72ed3d5e79c0a50a09d31de988.tar.xz
chore: add README
-rwxr-xr-xREADME.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100755
index 0000000..7449643
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Flic 2 Button Client Library written in Rust
+
+This is a library for the Flic 1 and Flic 2 Button.
+
+You can create a client that connects to a server and gets notified when a registered button is activated. This is called receiving an *Event*.
+
+With this client you can also transmit *Command*s to the server to perform distinct actions on the server like scanning for new buttons.
+
+## Where you can get a server
+
+[This github project](https://github.com/50ButtonsEach) has implementations of sdks and clients in different languages and environments.
+
+For instance, there you can get FlicSDK.exe which is a server for Windows.
+
+## Examples
+
+- ping -- just pings the server
+- simpleclient -- performs button scans and registers buttons
+
+Hint: IP addresses and BlueTooth addresses should to be replaced to your needs to work properly. \ No newline at end of file