diff --git a/README.md b/README.md new file mode 100644 index 0000000..1845ba0 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +LibAPRS +========== + +LibAPRS is an Arduino IDE library that makes it easy to send and receive APRS packets with a [MicroModem](http://unsigned.io/micromodem)-compatible modem. + +You can buy a complete modem from [my shop](http://unsigned.io/shop), or you can build one yourself pretty easily. Take a look at the documentation in the [MicroModem](https://github.com/markqvist/MicroModem) repository for information and getting started guides! + +See the example included in the library for info on how to use it! + +## Some features + +- Send and receive AX.25 APRS packets +- Full modulation and demodulation in software +- Easy configuration of callsign and path settings +- Easily process incoming packets +- Shorthand functions for sending location updates and messages, so you don't need to manually create the packets +- Ability to send raw packets +- Support for settings APRS symbols +- Support for power/height/gain info in location updates +- Can run with open squelch \ No newline at end of file