aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
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