Update README.md

yuk7 · Dec 1, 2021 · 97db320 · 97db320
1 parent 9ff1d6e
commit 97db320
Showing 1 changed file with 24 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,24 @@
-# wsllib-go
+# wsllib-go
+A WSL Library for Golang.
+
+## Usage
+Get this package
+```
+go get github.com/yuk7/wsllib-go
+```
+
+## Example
+```go
+package main
+
+import "github.com/yuk7/wsllib-go"
+
+func main() {
+    wsllib.WslLaunchInteractive("DistroName", "", true)
+}
+```
+
+## Notes
+WslLaunchInteractive is not used in this library as it causes problems in goroutine.
+
+Instead, a function is defined to connect stdin, stdout, stderr to WslLaunch.