Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
CelliesProjects authored Feb 20, 2021
1 parent 44ee438 commit 80fbefc
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
<br>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)

Expand Down

0 comments on commit 80fbefc

Please sign in to comment.