1
0
mirror of https://github.com/taigrr/log-socket synced 2025-01-18 04:53:14 -08:00

Merge pull request #10 from ethanholz/README

Added a README
This commit is contained in:
Tai Groot 2022-10-10 13:38:59 -07:00 committed by GitHub
commit 147a8cb30b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

15
README.md Normal file
View File

@ -0,0 +1,15 @@
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`
## 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.