update: basic informations

changkun · changkun · commit 424fad456ae8 · 2019-07-17T15:54:58.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -10,3 +10,4 @@
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
+*.html
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Ou Changkun
+Copyright (c) 2019 Ou Changkun
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -1,2 +1,11 @@
 # lockfree
-lock-free data structure library written in go
+
+Package lockfree offers lock-free utilities in Go.
+
+## Contributing
+
+We would love to have your experiences. Feel free to [submit an issue](https://github.com/changkun/lockfree/issues/new) for requesting new implementation or bug report.
+
+## License
+
+MIT &copy; [Changkun Ou](https://changkun.de)
diff --git a/doc.go b/doc.go
@@ -0,0 +1,2 @@
+// Package lockfree offers lock-free utilities
+package lockfree

Original file line number	Diff line number	Diff line change
`@@ -10,3 +10,4 @@`
`10`	`10`
`11`	`11`	`# Output of the go coverage tool, specifically when used with LiteIDE`
`12`	`12`	`*.out`
	`13`	`+*.html`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+// Package lockfree offers lock-free utilities`
	`2`	`+package lockfree`