Update README.md

Julia-Embedded · Nov 12, 2024 · 9efb427 · 9efb427
1 parent e900c2d
commit 9efb427
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -57,11 +57,15 @@ Pkg.add("PiGPIO")
 
 using PiGPIO
 
-pi=Pi() #connect to pigpiod daemon on localhost
+pi=Pi() # connect to the pigpiod daemon on localhost
 ```
 
 ## Example Usage
 
+The `pin` number corresponds to the GPIO pins
+(General Purpose Input/Output, aka "BCM" or "Broadcom") and not 
+to the physical pin numbers.
+
 ```julia
 set_mode(pi::Pi, pin::Int, mode)
 get_mode(pi::Pi, pin::Int)