Merge branch 'master' of github.com:JuliaBerry/JuliaBerry.jl

JuliaBerry · Jul 14, 2019 · 1cab18e · 1cab18e · aviks · Jul 14, 2019
2 parents a5581c1 + 8d0291a
commit 1cab18e
Showing 1 changed file with 43 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,46 @@
 # JuliaBerry
 
-[![Build Status](https://travis-ci.org/aviks/JuliaBerry.jl.svg?branch=master)](https://travis-ci.org/aviks/JuliaBerry.jl)
+An omnibus package with a high level API for controlling peripherals on the Raspberry Pi computer. Currently has support for the GPIO pins on the Pi, and the ExplorerHat. 
 
-An omnibus package with a high level API for controlling peripherals on the Raspberry Pi computer. 
+## GPIO
+
+### Generic Pins
+
+```
+x = OutputPin(17)
+on(x)
+off(x)
+```
+
+### LED
+
+```
+x = LED(17)
+on(x)
+off(x)
+```
+
+### Motors
+
+```
+x = Motor(17, 23)
+forward(x, 50)
+stop(x)
+backward(x, 50)
+stop(x)
+```
+
+## Explorer Hat
+
+```
+using JuliaBerry.ExplorerHat
+
+on(ExplorerHat.led[1])
+on.(ExplorerHat.led)
+off.(ExplorerHat.led)
+
+on(ExploerHat.output[1])
+
+forward(ExplorerHat.motor[1], 75)
+stop(ExplorerHat.motor[1])
+```