From 284d817d3a264dbe537a6d7873bfbf3363d02457 Mon Sep 17 00:00:00 2001
From: Jannik Beyerstedt <code@jannikbeyerstedt.de>
Date: Wed, 25 Mar 2020 12:49:32 +0000
Subject: [PATCH] Update 'README.md'

---
 README.md | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index deb169d..8d43833 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,11 @@
-# Readme
+# ESP32-based Environmental Sensor
+A simple temperature and humidity sensor node using an ESP32 and a Si7021 sensor element running of a 18650 LiIon battery cell.
+The sensor outputs the data to an influxdb instance, which must be reachable via HTTP.
+
+To save energy, we use a lower CPU frequency.
+But this requires compiling the core framework again with the changed settings (see below).
+
+This repository contains the code running on the ESP32, as well as the PCB and case design.
 
 ## Dependencies
 Prepare toolchain (macOS):
@@ -40,7 +47,7 @@ git clone --recursive https://github.com/espressif/esp-idf.git
 ```
 
 
-## Checkout this project and configure arduino-es32 with esp-idf:
+## Checkout this project and configure arduino-esp32 with esp-idf:
 ```
 TODO!!
 
-- 
2.43.5