aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJakob Odersky <jakob@driver.xyz>2018-09-12 14:06:27 -0700
committerJakob Odersky <jakob@driver.xyz>2018-09-12 14:21:22 -0700
commit42244b1121c68ce86f757e35fabdaae0792185a5 (patch)
tree0639791cc3c0d07146b6acd48ddb2770c59a3f75
parent0c67bd769c5d4c674dd8307ecf85cd5b7815b003 (diff)
downloaddriver-core-42244b1121c68ce86f757e35fabdaae0792185a5.tar.gz
driver-core-42244b1121c68ce86f757e35fabdaae0792185a5.tar.bz2
driver-core-42244b1121c68ce86f757e35fabdaae0792185a5.zip
Update README
[skip ci]
-rw-r--r--README.md23
1 files changed, 22 insertions, 1 deletions
diff --git a/README.md b/README.md
index e65edf5..a2d3649 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,25 @@
-# Driver Core Library [![Build Status](https://travis-ci.com/drivergroup/driver-core.svg?token=S4oyfBY3YoEdLmckujJx&branch=master)](https://travis-ci.com/drivergroup/driver-core)
+----
+
+Notice: the master branch is for development work on the **upcoming
+2.0 release**, which is still unstable. Any changes to a previous
+version of core should be developed against master and then
+cherry-picked onto the [1.x
+branch](https://github.com/drivergroup/driver-core/tree/1.x).
+
+----
+
+# Driver Core Library for Scala Services [![Build Status](https://travis-ci.com/drivergroup/driver-core.svg?token=S4oyfBY3YoEdLmckujJx&branch=master)](https://travis-ci.com/drivergroup/driver-core)
+
+Multi-cloud utilities and application initialization framework.
+
+This library offers many common utilities for building applications
+that run on multiple environments, including Google Cloud, Ali Cloud,
+and of course on development machines.
+
+
+# Overview
+
+*This section applies to the 1.x series of core. The current development master branch may include changes not described here.*
Core library is used to provide ways to implement practices established in [Driver service template](http://github.com/drivergroup/driver-template) (check its [README.md](https://github.com/drivergroup/driver-template/blob/master/README.md)).