From e9dd3dc843608711bc8fb7c8a90c028e00725bf6 Mon Sep 17 00:00:00 2001 From: jgromes Date: Sat, 2 Nov 2024 11:01:43 +0100 Subject: [PATCH] Added quick links to readme --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c608e2d6..81570a43 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,6 @@ ## Universal wireless communication library for embedded devices -## See the [Wiki](https://github.com/jgromes/RadioLib/wiki) and [FAQ](https://github.com/jgromes/RadioLib/wiki/Frequently-Asked-Questions) 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, protocols and even digital modes into a single consistent system. Want to add a Bluetooth interface to your LoRa network? Sure thing! Do you just want to go really old-school and play around with radio teletype, slow-scan TV, or even Hellschreiber using nothing but a cheap radio module? Why not! @@ -13,6 +11,12 @@ RadioLib natively supports Arduino, but can run in non-Arduino environments as w 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 microcontroller can handle! +### Quick links: +* [__Wiki__](https://github.com/jgromes/RadioLib/wiki) - contains useful general information on using this library +* [__FAQ__](https://github.com/jgromes/RadioLib/wiki/Frequently-Asked-Questions) - frequently asked questions, and answers +* [__API Reference__](https://jgromes.github.io/RadioLib) - full API reference, automatically generated from the source code +* [__Status Code Decoder__](https://jgromes.github.io/status_decoder/decode.html) - decoder for status codes returned by RadioLib methods + ### Supported modules: * __CC1101__ FSK radio module * __LLCC68__ LoRa module