From 70ba28090de48dc8c995309b0f2de6ab6b2a1d0a Mon Sep 17 00:00:00 2001 From: Shirou WAKAYAMA Date: Tue, 22 Mar 2016 21:51:43 +0900 Subject: [PATCH 1/2] add version 2 breaking change notification to README. --- README.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index cd851c82..05693f3b 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,10 @@ gopsutil: psutil for golang This is a port of psutil (http://pythonhosted.org/psutil/). The challenge is porting all psutil functions on some architectures... -.. highlights:: Package Structure Changed! - Package (a.k.a. directory) structure has been changed!! see `issue 24 `_ +.. highlights:: Breaking Changes will comes! + + We introduced versioning by using gopkgin. And breaking changes will be introduced at v2. See `issue 174 `_ . Available Architectures @@ -32,12 +33,14 @@ All works are implemented without cgo by porting c struct to golang struct. Usage --------- +Note: gopsutil.v2 breaks compatibility. If you want to stay with compatibility, please use `gopkg.in/shirou/gopsutil.v1`. + .. code:: go import ( "fmt" - "github.com/shirou/gopsutil/mem" + mem "gopkg.in/shirou/gopsutil.v2" ) func main() { From be06a94d4487f6562f3c8dbfa6e51689406e0c61 Mon Sep 17 00:00:00 2001 From: Shirou WAKAYAMA Date: Tue, 22 Mar 2016 21:55:16 +0900 Subject: [PATCH 2/2] fix the gopkgin versioning on README. --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 05693f3b..d363c49e 100644 --- a/README.rst +++ b/README.rst @@ -40,7 +40,7 @@ Note: gopsutil.v2 breaks compatibility. If you want to stay with compatibility, import ( "fmt" - mem "gopkg.in/shirou/gopsutil.v2" + mem "gopkg.in/shirou/gopsutil.v2/mem" ) func main() {