forks/RadioLibSmol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Jan Gromeš 2019-02-05 09:59:11 +01:00 • committed by GitHub
parent 274c56aa92
commit 77caff43bf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -1,13 +1,13 @@
# KiteLib [![Build Status](https://travis-ci.org/jgromes/KiteLib.svg?branch=master)](https://travis-ci.org/jgromes/KiteLib)
# RadioLib [![Build Status](https://travis-ci.org/jgromes/KiteLib.svg?branch=master)](https://travis-ci.org/jgromes/KiteLib)
### _One radio library to rule them all!_
## Universal wireless communication library for Arduino
KiteLib 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? KiteLib has got your back!
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!
KiteLib was originally created as a driver for the [__KITE shield__](https://github.com/jgromes/KiteShield), 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!
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:
@ -35,7 +35,7 @@ KiteLib was originally created as a driver for the [__KITE shield__](https://git
## Frequently Asked Questions
### Where should I start?
First of all, take a look at the [examples](https://github.com/jgromes/KiteLib/tree/master/examples) and the [Wiki](https://github.com/jgromes/KiteLib/wiki). There's a lot of useful information over there. Also, you should check out [KITE shield](https://github.com/jgromes/KiteShield) - open source Arduino shield that will allow you to easily connect any two wireless modules supported by KiteLib!
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). 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!
### KiteLib 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 KiteLib, 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.
### 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.