From 87e0e999a84c8b03b88f6a546a6d77c7b15a2192 Mon Sep 17 00:00:00 2001
From: Prashant Sinha <prashant@noop.pw>
Date: Sun, 12 Sep 2021 12:36:23 +0200
Subject: [PATCH] Add a readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f050fd6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# esphome-frekvens-component
+
+A custom component for esp-home to interface with IKEA's Frekvens Cube.
+
+## Sources
+
+This repo is heavily based on the original [FrekvensPanel library by @frumperino][https://github.com/frumperino/FrekvensPanel].
+
+It's also inspired from the esphome component PCD8544.
+
+## Usage
+
+Currently there is a dependency upon Adafruit GFX library. In your esphome config, add these lines:
+
+- Declare necessary libraries
+- Define frekvenspanel component
+
+## License
+[TBD] the original library does not specify the license. This repo is consecutively not licensed yet either.