aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlan Donovan <adonovan@google.com>2018-10-23 11:08:14 -0400
committerAlan Donovan <adonovan@google.com>2018-10-23 11:08:14 -0400
commit4005b3cdd12b84d2e2f39ff537fab964e66d6ea8 (patch)
tree1123b79e5b4e6c256983b16ce566bf494feec2ce /README.md
parente3deafefac22db7bfd4877d37614fe5db4b03881 (diff)
downloadstarlark-go-4005b3cdd12b84d2e2f39ff537fab964e66d6ea8.tar.gz
README: add warning
Change-Id: I64721b972dba5cf35755b47915c7345592f79fe4
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1b8e0f9..96ca73f 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,12 @@
This is the home of the _Starlark in Go_ project.
Starlark in Go is an interpreter for Starlark, implemented in Go.
-Starlark was formerly known as Skylark.
+
+*Starlark was formerly known as Skylark and is currently in transition
+to the new name. We will use this as an opportunity to make some
+breaking API changes. The import path for the Go packages will
+eventually be `go.starlark.net/starlark`, but it does not work yet.
+Please continue to import the old Skylark names for now.*
Starlark is a dialect of Python intended for use as a configuration language.
Like Python, it is an untyped dynamic language with high-level data