aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJon Pretty <jon.pretty@propensive.com>2017-06-12 14:19:18 +0200
committerJon Pretty <jon.pretty@propensive.com>2017-06-12 14:19:18 +0200
commite5806354a54c265c833c8b63f7eb86473fdb888d (patch)
tree42da45fe3b23bb66240c234813b07027cff5820c /README.md
parent4d1e10dff683150b687c413b80e38ae0aba632c5 (diff)
downloadmagnolia-e5806354a54c265c833c8b63f7eb86473fdb888d.tar.gz
magnolia-e5806354a54c265c833c8b63f7eb86473fdb888d.tar.bz2
magnolia-e5806354a54c265c833c8b63f7eb86473fdb888d.zip
Include readme and license
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ebc850e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+[![Latest version](https://index.scala-lang.org/propensive/magnolia/latest.svg)](https://index.scala-lang.org/propensive/magnolia)
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.propensive/magnolia_2.12/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.propensive/magnolia_2.12)
+
+# Magnolia
+
+Magnolia is a generic macro for automatic derivation of typeclasses for
+datatypes composed from case classes and sealed traits. It supports
+recursively-defined datatypes out-of-the-box, and incurs no significant
+time-penalty during compilation. If derivation fails, error messages are
+detailed and informative.
+
+Please see the [Magnolia](http://magnolia.work/) website for more information.
+