aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c3fedf2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Basic sbt template
+
+A basic sbt template that features:
+
+- Basic Scala project setup
+- Versioning directly tied to git
+- Continuous integration and automatic publishing to Sonatype when tags are pushed
+
+## Usage
+
+1. Initialize project
+
+ sbt new jodersky/standard.g8
+
+2. Set up github repository and travis
+
+3. Add publishing credentials to travis
+
+ travis encrypt GPG_PASS=$(pass infra/ci-gpg) --add
+ travis encrypt SONATYPE_PASS=$(pass infra/ci-sonatype) --add
+