From 1bb96f8ac270693c6076e3771aab34a15c27e04a Mon Sep 17 00:00:00 2001
From: Torsten Grote <t@grobox.de>
Date: Thu, 9 Jun 2022 08:55:25 -0300
Subject: [PATCH] Add readme

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..eb7de15
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Do not kill me library
+
+An Android library helping to keep a foreground service with wake-locks running. No other use-cases considered.
+
+## Include in your project
+
+    implementation 'org.briarproject:dont-kill-me-lib:[version]'
+
+where `[version]` is the latest version.
+
+## Publishing
+
+To publish latest release in staging repo on maven central:
+
+    ./gradlew publish
+
+To do the actual release from staging repo to maven central:
+
+    ./gradlew closeAndReleaseRepository
+
+Alternatively, visit https://oss.sonatype.org/#stagingRepositories and release there.
-- 
GitLab