mirror output to stdout and http

1 files changed, 16 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0de5e9b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+log
+
+This is an attempt to modify the default golang 'log'.
+Because the 'gui' toolkit could be either ncurses or something like gtk,
+'log' is an attempt to be smart about changing STDOUT on the fly.
+
+* add meaningful shortcuts like log.Info(), log.Warn(), log.Error() etc
+* add flags to enable & disable output on a per-gomodule basis
+* add http flag to switch stdout to http socket
+* compatible with changing import 'log' to import 'go.wit.com/log'
+* should also be compatible with changing import 'fmt' to import fmt 'go.wit.com/log'
+
+Notes & Goals:
+
+* be a complete droplet replacement for golang 'log'
+* provide an example of how the stdlib 'log' could be changed