v0.1

README.md

@@ -1,2 +1,48 @@
 # pyBittle
-Documentation: [pyBittle](https://enriquemoran95.gitbook.io/pybittle/)
+
+pyBittle is an Open Source Python library for easily connecting to Bittle and controlling it.
+This library provides a set of methods to communicating with Bittle through Bluetooth abd WiFi, allowing to control it remotely.
+
+In-depth documentation and usage examples: [pyBittle](https://enriquemoran95.gitbook.io/pybittle/)
+
+
+## Usage example
+
+Connecting to Bittle and sending commands is as easy as follows:
+
+```python
+bittle = pyBittle.Bittle()  # This is your Bittle
+
+is_connected = bittle.connect_bluetooth()  # Returns True if Bittle is connected to your computer
+
+if is_connected:
+    greet_command = pyBittle.Command.GREETING  # This is 'khi' message to be sent
+    bittle.send_command_bluetooth(greet_command)  # Send 'khi' message through Bluetooth
+```
+
+```python
+bittle = pyBittle.Bittle()
+
+bittle.wifiManager.ip = '192.168.1.241'  # This is your Bittle's IP address
+
+push_up_command = pyBittle.Command.GREETING  # This is 'kpu' message to be sent
+
+has_connection = bittle.has_wifi_connection()
+if has_connection:
+    bittle.send_command_wifi(push_up_command)  # Send 'kpu' message through WiFi
+```
+
+## Installation
+
+pyBittle has the following dependencies: [PyBluez](https://github.com/pybluez/pybluez) and [pySerial](https://github.com/pyserial/pyserial), install them using the following commands:
+
+```
+sudo apt-get install libbluetooth-dev
+sudo apt-get install python-dev
+pip install pybluez
+
+pip install pyserial
+
+git clone https://github.com/EnriqueMoran/pyBittle.git
+pip install .
+```