final readme

Author: shashankmarch27

Diff for: Docs/index.md

@@ -3,37 +3,37 @@ DriveMaster is a common library designed to simplify the implementation of RC pr
 
 # Supported Protocol
 
-- [DShot300](#dshot300)
-- [DShot600](#dshot600)
+- [DShot](#dshot)
 
-## DShot300 {#dshot300}
+## DShot {#dshot}
 
-### Configuration
+### Frame Structure
+The DShot frame consists of 16 bits and follows a specific structure:
 
-- Baud rate: 100000
-- Data bits: 8 Bits
-- Parity: Even Parity
-- Stop bits: 2 Stop bits
-- Signal polarity: Inverted
+- **Throttle**: 11 bits representing throttle values ranging from 48 to 2047.
+- **Telemetry Request**: 1 bit indicating whether telemetry data is requested.
+- **CRC**: 4 bits for error checking using a cyclic redundancy check.
 
-## DShot600 {#dshot600}
+### DShot Versions and Bitrates
+Different versions of DShot support varying bitrates and durations for high and low signal times:
+
+| DShot Version | Bitrate (bps) | T1H (µs) | T0H (µs) | Bit Length (µs) | Frame Length (µs) |
+|---------------|----------------|----------|----------|-----------------|-------------------|
+| DShot150      | 150,000        | 5.00     | 2.50     | 6.67            | 106.72            |
+| DShot300      | 300,000        | 2.50     | 1.25     | 3.33            | 53.28             |
+| DShot600      | 600,000        | 1.25     | 0.625    | 1.67            | 26.72             |
+| DShot1200     | 1,200,000      | 0.625    | 0.313    | 0.83            | 13.28             |
 
-### Configuration
 
-- Baud rate: 420000
-- Data bits: 8 Bits
-- Parity: No Parity
-- Stop bits: 1 Stop bits
-- Signal polarity: Uninverted
 
 # Getting Started
 - [Installation](#installation)
 - [Tutorial](#tutorial)
 - [Examples](#example)
 
-# Installation {#installation}
+## Installation {#installation}
 
-## Arduino Installation
+### Arduino Installation
 
 To use the DriveMaster library in your Arduino projects, follow these installation steps:
 
@@ -43,16 +43,16 @@ To use the DriveMaster library in your Arduino projects, follow these installati
 4. Restart the Arduino IDE.
 5. You should now be able to include the DriveMaster library in your Arduino sketches.
 
-## PlatformIO Installation
+### PlatformIO Installation
 
 If you are using PlatformIO, you can install the DriveMaster library directly from the PlatformIO Library Manager. Add the following line to your `platformio.ini` file:
 
 ```ini
 lib_deps = Witty-Wizard/DriveMaster @ ^0.1.0
 ```
-# Tutorial {#tutorial}
+## Tutorial {#tutorial}
 
-## Using DriveMaster Library for Motor Control
+### Using DriveMaster Library for Motor Control
 
 To control motors in your Arduino project using the DriveMaster library, follow these steps:
 
@@ -90,10 +90,10 @@ motor->sendCommand(1000);
 motor->sendValue(512);
 ```
 
-# Examples {#example}
+## Examples {#example}
 
-## DShot Example
-@include "../examples/basic_dshot/basic_dshot.ino"
+### DShot Example
+@include "./examples/basic_dshot/basic_dshot.ino"
 
 # License
 This library is distributed under the GNU [General Public License version 3.0](https://www.gnu.org/licenses/gpl-3.0.html).

Diff for: examples/basic_dshot/basic_dshot.ino

@@ -13,7 +13,6 @@ void setup() {
 }
 
 void loop() {
-  // Example: Set motor speed to 50% duty cycle
   motor->sendValue(512);
   delay(1000); // Delay for 1 second
 }