aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob Odersky <jodersky@gmail.com>2015-03-20 12:07:41 +0100
committerJakob Odersky <jodersky@gmail.com>2015-03-20 12:07:41 +0100
commit3147aba7dc79e64d2da50d7d1c705bfd0e99eeca (patch)
tree6c0babfa3e227e3407a0fe250059724f303ad08a /README.md
parent1cf6e37dc356144f3da2a2dcde75d1ced8bc5ad6 (diff)
downloadsbt-mavlink-3147aba7dc79e64d2da50d7d1c705bfd0e99eeca.tar.gz
sbt-mavlink-3147aba7dc79e64d2da50d7d1c705bfd0e99eeca.tar.bz2
sbt-mavlink-3147aba7dc79e64d2da50d7d1c705bfd0e99eeca.zip
implement testing
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index bb894af..716a2d2 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,13 @@
# SBT-MAVLink Plugin
-This plugin aims to provide generation of Scala sources from MAVLink message definition files. \ No newline at end of file
+This plugin provides generation of Scala sources from MAVLink message definition files.
+It translates a MAVLink dialect defined in XML to useable scala objects and provides utilities for parsing
+and creating MAVLink packets.
+
+See an example
+
+## Usage
+Add the following to your plugins:
+
+ addSbtPlugin("com.github.jodersky" % "sbt-mavlink" % "0.1")
+