From e97d37012eff295d959e42a6622e0d6d4227b02f Mon Sep 17 00:00:00 2001 From: Ethan Holz Date: Mon, 10 Oct 2022 12:09:29 -0500 Subject: [PATCH 1/2] docs: Added inital README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..008c9e1 --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +log-socket +========== +`log-socket` is a drop-in replacement for Go's `log` package that allows for streaming of logs via WebSockets. + +## Installation +To install the library: +`go get github.com/taigrr/log-socket` + From 8e044e399361debef2fd5b66153f3aa758ed081e Mon Sep 17 00:00:00 2001 From: Ethan Holz Date: Mon, 10 Oct 2022 12:16:52 -0500 Subject: [PATCH 2/2] docs: Updated README to include running example. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 008c9e1..3442643 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,10 @@ log-socket To install the library: `go get github.com/taigrr/log-socket` +## Running +To run a demo of this library: +`go run main.go` + +This demo will do a sample of every log type and push results to `0.0.0.0:8080`. Once running, you can open a browser and navigate to +`0.0.0.0:8080` to see an example implementation of how logs are streamed. +