summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPietro Gagliardi <[email protected]>2014-06-09 23:04:19 -0400
committerPietro Gagliardi <[email protected]>2014-06-09 23:04:19 -0400
commite432e6fecff4554ceccb0e9dbc7a8b915fc90d2b (patch)
treee17c5d4ab3f85c04bf0586f3a5bd5ec0cd2c4d5f /README.md
parenta0e8048b06d52846157bc881e6cad8c119f807fd (diff)
Declared the API as it stands now stable.
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 117a456..182ed18 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@ Woah, lots of attention! Thanks!
This is a placeholder README; the previous file (olddocs/oldREADME.md) was rather long and confusing. I'll be rewriting it properly soon.
Until then, here's the important things you need to know:
-- **this package is very much incomplete and until I clear out the existing set of TODOs has an API which may change without warning** (the API is stable for the most part)
+- **this package is very much incomplete; see `stable.md` for a list of what is guaranteed to not change at the API level — for everything newer, you have been warned!**
- this package requires Go 1.3, which is presently available as a RC build (source builds from go tip will work too)
- I don't think the Windows side uses any Go 1.3 features, but just to be safe I'm going to say express caution
- Unix builds need 1.3 to fix some type-checker bugs in cgo