aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README12
-rw-r--r--README.md20
-rw-r--r--build.xml1
3 files changed, 21 insertions, 12 deletions
diff --git a/README b/README
deleted file mode 100644
index b6fc5e26..00000000
--- a/README
+++ /dev/null
@@ -1,12 +0,0 @@
-Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java.
-Never write another getter or equals method again, with one annotation your class has a fully featured builder, Automate your logging variables, and much more.
-
-See LICENSE for the Project Lombok license.
-
-Looking for professional support of Project Lombok? Lombok is now part of a tidelift subscription!
-
-For a list of all authors, see the AUTHORS file.
-
-For complete project information, see https://projectlombok.org/
-
-You can review our security policy via SECURITY.md
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..1b5ba74d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Project Lombok
+
+Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java.
+Never write another getter or equals method again, with one annotation your class has a fully featured builder, automate your logging variables, and much more.
+
+See [LICENSE][licence-file] for the Project Lombok license.
+
+Looking for professional support of Project Lombok? Lombok is now part of a [tidelift subscription][tidelift-sub]!
+
+For a list of all authors, see the [AUTHORS][authors-file] file.
+
+For complete project information, see [projectlombok.org][projectlombok-site]
+
+You can review our security policy via [SECURITY.md][security-file]
+
+[licence-file]: https://github.com/rzwitserloot/lombok/blob/master/LICENSE
+[authors-file]: https://github.com/rzwitserloot/lombok/blob/master/AUTHORS
+[security-file]: https://github.com/rzwitserloot/lombok/blob/master/SECURITY.md
+[projectlombok-site]: https://projectlombok.org/
+[tidelift-sub]: https://tidelift.com/subscription/pkg/maven-org-projectlombok-lombok?utm_source=maven-org-projectlombok-lombok&utm_medium=referral&campaign=website
diff --git a/build.xml b/build.xml
index 4f921e7d..c21d1401 100644
--- a/build.xml
+++ b/build.xml
@@ -334,6 +334,7 @@ lombok.launch.AnnotationProcessorHider$ClaimingProcessor,isolating</echo>
<echo file="release-timestamp.txt">${releaseTimestamp}</echo>
<zip destfile="dist/lombok-${lombok.version}.jar">
<fileset dir="build" includes="changelog.txt, latestchanges.html" />
+ <fileset dir="." includes="README.md" />
<fileset dir="." includes="LICENSE" />
<fileset dir="." includes="AUTHORS" />
<fileset dir="." includes="release-timestamp.txt" />