From 3c7d9e0d6d6a37c2fa50992df127d6aa48b111f1 Mon Sep 17 00:00:00 2001 From: Charles Iliya Krempeaux Date: Sat, 10 Oct 2015 17:18:09 -0700 Subject: [PATCH] added to docs --- doc.go | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 doc.go diff --git a/doc.go b/doc.go new file mode 100644 index 0000000..3d386fe --- /dev/null +++ b/doc.go @@ -0,0 +1,28 @@ +/* +Package flog provides structured and formatted logging. + +Basic Usage + +Basic usage of the flogger looks like this: + + router := NewPrettyWritingRouter(os.Stdout) + + flogger := flog.New(router) + +Once you have this, you can do things such as: + + flogger.Print("Hello world!") + flogger.Println("Hello world!") + flogger.Printf("Hello %s!", name) + + flogger.Panic("Uh oh!") + flogger.Panicln("Uh oh!") + flogger.Panicf("Uh oh, had a problem happen: %s.", problemDescription) + + flogger.Fatal("Something really bad happened!") + flogger.Fatalln("Something really bad happened!") + flogger.Fatalf("Something really bad happened: %s.", problemDescription) + + +*/ +package flog