From c284eb841c5f7f28ba8e23cc02e398b0d91891bd Mon Sep 17 00:00:00 2001 From: Manuel Bleichenbacher Date: Sat, 21 Jul 2018 17:02:41 +0200 Subject: [PATCH] Shorter README --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8256ec1..43afc2c 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,19 @@ # ttn-esp32 -**The Things Network device library for ESP-IDF (ESP32)** +**The Things Network device library for ESP-IDF (ESP32) supporting devices with Semtech SX127x chips** -This ESP32 component provides LoRaWAN communication with [The Things Network](https://www.thethingsnetwork.org/). It supports OTAA (over-the-air activation), uplink and downlink messages. +This ESP32 component provides LoRaWAN communication with [The Things Network](https://www.thethingsnetwork.org/). It supports OTAA (over-the-air activation), uplink and downlink messages and saving the EUIs and key in non-volatile memory. -## Installation +The library is based on the LMIC library from IBM and provides a high-level API specifically targeted at The Things Network. -Install the component by adding it as a git submodule: +## Get Started - git submodule add https://github.com/manuelbl/ttn-esp32.git components/ttn-esp32 - git submodule update --init --recursive +Follow the detailed [Get Started Guide](https://github.com/manuelbl/ttn-esp32/wiki/Get-Started) in the Wiki. -The frequency plan must be configured by running `make menuconfig`. Otherwise the component will not compile. In the menu it can be found at *Components* / *The Things Network*. +## Supported Boards + +All boards with Semtech SX127x chips, RFM9x and compatibles are supported. It includes boards from ttgo, Heltec and HopeRF. -More to follow... ## Resources