Add changelog, update readme to reflect coming v1 release

bastjan · Nov 3, 2018 · 32b5c01 · 32b5c01
1 parent 9affdbe
commit 32b5c01
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,22 @@
+# v1.0.0 / 3.11.2018
+
+Changes:
+* 9affdbe Add go mod files
+* 5df161a Add Connection.User() to lookup user associated with the connection
+* 2ae5436 Add UserID, Transmit/ReceiveQueue to Connection
+* 644fb01 Add TCPState TCPNewSynRecv
+* a509188 Add Connection.State to represent the tcp state of a connection
+
+Not Backwards Compatible Changes:
+* 94a7073 Rename Netstat to Protocol, add Name field, reference in Connection
+* 3dc8bec Connections(): Return pointers to connections
+* a8c2beb Change type of Netstat from string to struct.
+
+# v0.2.0-beta.1 / 16.10.2018
+
+Not Backwards Compatible Changes:
+* 73dd025 Rename Entries() to Connections() to be more symmetrical
+
+# v0.1.0-beta.1 / 16.10.2018
+
+Initial release
diff --git a/README.md b/README.md
@@ -18,10 +18,11 @@ netstat.UDP6.Connections()
 
 See [netstat_tulpen.go](examples/netstat_tulpen/netstat_tulpen.go) for a more throughout example.
 
-## Development Status: Work in Progress
+## Development Status: Stable
 
-The api is not yet final and can change.
-First stable release will be version 1.0.0.
+This library is v1 and follows SemVer.
+
+No breaking changes will be made to exported APIs before v2.0.0.
 
 ## Support for Mac OS and *BSD