Update README.md

This commit is contained in:
Sergey Karmanov 2023-04-06 21:06:50 +03:00
parent 84f447639b
commit 47819c8b43
Signed by: serega404
GPG Key ID: 97CADD982D88DF68

View File

@ -1,3 +1,36 @@
# LuaShiftOut # LuaShiftOut
Port of the Arduino shiftOut function. [![MIT License](https://img.shields.io/github/license/serega404/LuaShiftOut)](https://github.com/serega404/LuaShiftOut/blob/main/LICENSE)
Port of the Arduino shiftOut function.
## Installation <sub><sup>(for rasbian and debian-based)</sup></sub>
``` bash
sudo apt install luarocks lua-bitop
sudo luarocks install lua-periphery
```
## Usage
``` lua
require("shiftOut")
register = shiftOut:new(LatchPin, DataPin, ClockPin)
register:shiftOut("11000000") -- string value
register:shiftOut(192) -- decimal digit value
```
## Modules
* [lua-periphery](https://github.com/vsergeev/lua-periphery)
* [BitOp](http://bitop.luajit.org/)
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Feel free to contribute to this project.
## License
Distributed under the MIT License. See [`LICENSE`](./LICENSE) for more information.