From e432e6fecff4554ceccb0e9dbc7a8b915fc90d2b Mon Sep 17 00:00:00 2001 From: Pietro Gagliardi Date: Mon, 9 Jun 2014 23:04:19 -0400 Subject: Declared the API as it stands now stable. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') 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 -- cgit v1.2.3