From 80fbefc35ff05d759f87b79cfe4a8ea33a573f06 Mon Sep 17 00:00:00 2001 From: Cellie Date: Sat, 20 Feb 2021 16:46:44 +0100 Subject: [PATCH] Update README.md --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 66f55a2..85da0d4 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,18 @@ [![Codacy Badge](https://api.codacy.com/project/badge/Grade/8bc0dca32db84bb5a3b762be8d48d2b3)](https://www.codacy.com/manual/CelliesProjects/moonPhase?utm_source=github.com&utm_medium=referral&utm_content=CelliesProjects/moonPhase&utm_campaign=Badge_Grade) ### moonPhase -An esp32 library to get the moon phase angle and percentage of the moon that is illuminated. +A library for esp32 to get the moon phase angle and percentage of the moon that is illuminated. (as seen from Earth) +
Preferred methods to install is to use the Arduino IDE library manager. -#### Usage +For esp8266 non-os or avr (Arduino) you can use the [steve-sienk fork](https://github.com/steve-sienk/moonPhaser-avr). + + +#### Manual install 1. Download the latest release and unpack in the Arduino `libraries` folder. 2. Restart the Arduino IDE. -#### Functions: +#### Functions - `getPhase()` Get the current moon phase. (First set freeRTOS system time - see the esp32-sntp example)