Update docs

sevlyar · Sep 25, 2016 · 01bb5ca · 01bb5ca
1 parent 5de16e8
commit 01bb5ca
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 8 deletions.
diff --git a/LICENSE b/LICENSE
@@ -4,4 +4,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,13 +1,30 @@
 # go-daemon [![Build Status](https://travis-ci.org/sevlyar/go-daemon.png?branch=master)](https://travis-ci.org/sevlyar/go-daemon) [![GoDoc](https://godoc.org/github.com/sevlyar/go-daemon?status.png)](https://godoc.org/github.com/sevlyar/go-daemon)
- 
+
 Library for writing system daemons in golang.
 
+Now supported only UNIX-based OS (Windows is not supported). But the library was tested only on Linux
+and OSX, so that if you have an ability to test the library on other platforms, give me feedback, please.
+
 ## Installation
 
 	go get github.com/sevlyar/go-daemon
 
+You can use [gopkg.in](http://labix.org/gopkg.in):
+
+	go get gopkg.in/sevlyar/go-daemon.v0
+
+If you want to use the library in production project, please use vendoring,
+because i can not ensure backward compatibility before release v1.0.
+
 ## Idea
 
+We can not use `fork` syscall in Golang's runtime, because child process doesn't inherit
+threads and goroutines in that case. The library uses a simple trick: it runs its own copy with
+a mark - a predefined environment variable. Availability of the variable for the process means
+an execution in the child's copy. So that if the mark is not setted - the library executes
+parent's operations and runs its own copy with mark, and if the mark is setted - the library
+executes child's operations:
+
 ```go
 func main() {
 	Pre()
@@ -26,8 +43,3 @@ func main() {
 
 ![](img/idea.png)
 
-## History
-
-### 14.01.12
-* released new major version, old version moved to github.com/sevlyar/go-daemon/oldapi
-
diff --git a/img/idea.png b/img/idea.png
diff --git a/oldapi/sample/dmn.sh b/oldapi/sample/dmn.sh
@@ -60,4 +60,4 @@ case "$1" in
 		;;
 	*)
 		echo "Usage: dmn.sh {start|stop|status|reload|clean|log}"
-esac
+esac
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,4 +4,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of

		The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

		THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
		THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-Original file line number
+Diff line change
@@ Expand Up / @@ -60,4 +60,4 @@ case "$1" in @@
     		;;
     	*)
     		echo "Usage: dmn.sh {start|stop|status|reload|clean|log}"
-    esac
+    esac