From 190701b4810885fa1d04c55b3f7985fff664c63b Mon Sep 17 00:00:00 2001
From: luciansabo <luciansabo@gmail.com>
Date: Mon, 8 Jul 2019 12:03:13 +0300
Subject: [PATCH] Create README.md

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..100d386
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# Sharp GP2Y* Dust Sensor library
+
+Arduino compatible (ESP8266, ESP32, etc) library for the Sharp GP2Y dust sensors:
+- GP2Y1010AU0F
+- GP2Y1014AU0F
+
+**Features:**
+- multi-reading average
+- running average
+- runtime calibration
+- sensitivity setting
+- offset adjustment (zero dust value)
+
+**Example:**
+
+```c++
+#include <GP2YDustSensor.h>
+
+const uint8_t SHARP_LED_PIN = 14;   // Sharp Dust/particle sensor Led Pin
+const uint8_t SHARP_VO_PIN = A0;    // Sharp Dust/particle analog out pin used for reading 
+
+GP2YDustSensor dustSensor(GP2YDustSensorType::GP2Y1014AU0F, SHARP_LED_PIN, SHARP_VO_PIN);
+
+void setup() {
+  Serial.begin(9600);
+  //dustSensor.setBaseline(0.4); // set no dust voltage according to your own experiments
+  //dustSensor.setCalibrationFactor(1.1); // calibrate against precision instrument
+  dustSensor.begin();
+}
+
+void loop() {
+  Serial.print("Dust density: ");
+  Serial.print(dustSensor.getDustDensity());
+  Serial.print(" ug/m3; Running average: ");
+  Serial.print(dustSensor.getRunningAverage());
+  Serial.println(" ug/m3");
+  delay(1000);
+}
+```