Skip to content

Commit b9bee46

Browse files
committed
documentation
1 parent 7d82d75 commit b9bee46

File tree

2 files changed

+16
-7
lines changed

2 files changed

+16
-7
lines changed

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A Shift Register Controller simple API for the 74hc595 adapted to small projects
44

55
---
66

7-
# Author and license
7+
## Author and license
88

99
Copyright (C) 2023 ollprogram
1010

@@ -19,20 +19,29 @@ If not, see <https://www.gnu.org/licenses/>.
1919

2020
---
2121

22-
# Description
22+
## Description
2323

2424
I made a very simple API in order to control a Shift Register like the 74hc595 without repeating the same code each time.
25-
This API also allows you to control multiple 74hc595 in cascade connection.
25+
This API also allows you to control multiple 74hc595 in cascade connection.
2626

2727
---
2828

29-
# Usage
29+
## Usage
3030

31-
Examples are available [here](examples/)
31+
All examples are available [here](examples/)
32+
33+
<br> You can set all bits by using a the display method with an integer (only working for less than 8 registers) or with a bit array. See the related examples :
34+
- [display using an 8 bits integer](examples/display8Bits/display8Bits.ino)
35+
- [display using a 16 bits integer](examples/display16Bits/display16Bits.ino)
36+
- [display using an array of bits](examples/displayArray/displayArray.ino)
37+
38+
Or you can also control bits of the shift register yourself bit by bit. See the related examples :
39+
- [shifting without writing each shift to the outputs](examples/silentShift/silentShift.ino)
40+
- [shifting and writing each shift to the outputs](examples/silentShift/silentShift.ino)
3241

3342
---
3443

35-
# Download and install
44+
## Download & Install
3645

3746
You can find and download the zip file in the releases.
3847

library.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ version=1.0.1
33
author=ollprogram
44
maintainer=ollprogram
55
sentence=Allows you to control easyly a shift register like the 74hc595
6-
paragraph=This library allows you to control the 74hc595 and change each values independently if needed. Also allows you to change the entire values of the register by reading bits of an integer or reading an array of bits.
6+
paragraph=This library allows you to control the 74hc595 and making the shifts easyly yourself or changing the entire values of the register by reading bits of an integer or reading an array of bits.
77
category=Device Control
88
url=https://github.com/ollprogram/SimpleShiftRegisterController
99
architectures=*

0 commit comments

Comments
 (0)