diff --git a/README.md b/README.md index d68e2a2f..7bedfa38 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,4 @@ -# RadioLib [](https://travis-ci.org/jgromes/RadioLib) +# RadioLib Development -### _One radio library to rule them all!_ - -## Universal wireless communication library for Arduino - -## See the [Wiki](https://github.com/jgromes/RadioLib/wiki) for further information. See the [GitHub Pages](https://jgromes.github.io/RadioLib) for detailed and up-to-date API reference. - -RadioLib allows its users to integrate all sorts of different wireless communication modules into a single consistent system. -Want to add a Bluetooth interface to your ZigBee network? Sure thing! Need to connect LoRa network to the Internet with a GSM module? RadioLib has got your back! - -RadioLib was originally created as a driver for [__RadioShield__](https://github.com/jgromes/RadioShield), but it can be used to control as many different wireless modules as you like - or at least as many as your Arduino can handle! - - -### Supported modules: -* __CC1101__ FSK radio module -* __ES8266__ WiFi module -* __HC05__ Bluetooth module -* __JDY08__ BLE module -* __RF69__ FSK/OOK radio module -* __RFM9x__ series LoRa modules (RFM95, RM96, RFM97, RFM98) -* __SX127x__ series LoRa modules (SX1272, SX1273, SX1276, SX1277, SX1278, SX1279) -* __SX126x__ series LoRa modules (SX1261, SX1262, SX1268) -* __SX1231__ FSK/OOK radio module -* __XBee__ modules (S2B) - -### Supported protocols: -* __MQTT__ for modules: ESP8266 -* __HTTP__ for modules: ESP8266 -* __RTTY__ for modules: SX127x, RFM9x, SX126x, RF69, SX1231 and CC1101 -* __Morse Code__ for modules: SX127x, RFM9x, SX126x, RF69, SX1231 and CC1101 - -### In development: -* __SIM800C__ GSM module -* __nRF24L01__ 2.4 GHz module -* __LoRaWAN__ protocol for SX127x, RFM9x and SX126x modules -* ___and more!___ - -## Frequently Asked Questions - -### Where should I start? -First of all, take a look at the [examples](https://github.com/jgromes/RadioLib/tree/master/examples) and the [Wiki](https://github.com/jgromes/RadioLib/wiki) - especially the [Basics](https://github.com/jgromes/RadioLib/wiki/Basics) page. There's a lot of useful information over there. Also, you should check out [RadioShield](https://github.com/jgromes/RadioShield) - open source Arduino shield that will allow you to easily connect any two wireless modules supported by RadioLib! - -### RadioLib doesn't support my module! What should I do? -Start by creating new issue (if it doesn't exist yet). If you have some experience with Arduino and C/C++ in general, you can try to add the support yourself! Use the template files in `/extras/` folder to get started. This is by far the fastest way to implement new modules into RadioLib, since I can't be working on everything all the time. If you don't trust your programming skills enough to have a go at it yourself, don't worry. I will try to implement all requested modules, but it will take me a while. +## WARNING: Here there be dragons ... and work-in-progress code! +Code in this branch is untested, unverified and often incomplete. If you only want to use RadioLib, [master branch](https://github.com/jgromes/RadioLib) is what you're looking for. If you're a contributor (or just curious), feel free to have a look around. Just don't expect the code to work.