From a44f3ac129b6a679346b09efea759a2842cf8b9e Mon Sep 17 00:00:00 2001 From: Marc-Antoine Ruel Date: Fri, 10 Mar 2017 14:17:50 -0500 Subject: [PATCH] Tidy up the docs. --- README.md | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 069b07c..bcd16fe 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,36 @@ # periph - Peripherals I/O in Go -Documentation and samples are at https://periph.io +Documentation is at https://periph.io + + +## Sample + +~~~go +package main + +import ( + "time" + "periph.io/x/periph/conn/gpio" + "periph.io/x/periph/host" + "periph.io/x/periph/host/rpi" +) + +func main() { + host.Init() + for l := gpio.Low; ; l = !l { + rpi.P1_33.Out(l) + time.Sleep(500 * time.Millisecond) + } +} +~~~ + +Visit https://periph.io for more samples. ## Authors -`periph` was initiated by [Marc-Antoine Ruel](https://github.com/maruel). The -full list of contributors is in +`periph` was initiated with ❤️️ and passion by [Marc-Antoine +Ruel](https://github.com/maruel). The full list of contributors is in [AUTHORS](https://github.com/google/periph/blob/master/AUTHORS) and [CONTRIBUTORS](https://github.com/google/periph/blob/master/CONTRIBUTORS).