Skip to content

Commit

Permalink
update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RobTillaart committed Oct 31, 2023
1 parent 78fab7f commit 9849ba4
Show file tree
Hide file tree
Showing 7 changed files with 30 additions and 11 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).


## [0.1.3] - 2023-02-20
- update readme.md
- update keywords.txt


## [0.1.3] - 2023-02-20
- optimized noInterrupts
- add lastRead()
Expand All @@ -14,7 +19,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- update license 2023
- minor edits


## [0.1.2] - 2022-11-06
- redo clock pulse to match fastShiftOut
(after write and before read)
Expand Down
6 changes: 3 additions & 3 deletions FastShiftInOut.cpp
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//
// FILE: FastShiftInOut.cpp
// AUTHOR: Rob Tillaart
// VERSION: 0.1.3
// VERSION: 0.1.4
// PURPOSE: Arduino library for (AVR) optimized shiftInOut (simultaneously)
// URL: https://github.com/RobTillaart/FastShiftInOut

Expand Down Expand Up @@ -84,12 +84,12 @@ uint8_t FastShiftInOut::writeLSBFIRST(uint8_t data)
*_clockRegister &= cbmask2;
}
SREG = oldSREG;

#else

for (uint8_t i = 0; i < 8; i++)
{
// write one bit
// write one bit
digitalWrite(_dataPinOut, value & 0x01);
value >>= 1;
// clock pulse
Expand Down
4 changes: 2 additions & 2 deletions FastShiftInOut.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
//
// FILE: FastShiftInOut.cpp
// AUTHOR: Rob Tillaart
// VERSION: 0.1.3
// VERSION: 0.1.4
// PURPOSE: Arduino library for (AVR) optimized shiftInOut (simultaneously)
// URL: https://github.com/RobTillaart/FastShiftInOut


#include "Arduino.h"


#define FASTSHIFTINOUT_LIB_VERSION (F("0.1.3"))
#define FASTSHIFTINOUT_LIB_VERSION (F("0.1.4"))


class FastShiftInOut
Expand Down
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
[![Arduino CI](https://github.com/RobTillaart/FastShiftInOut/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
[![Arduino-lint](https://github.com/RobTillaart/FastShiftInOut/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/FastShiftInOut/actions/workflows/arduino-lint.yml)
[![JSON check](https://github.com/RobTillaart/FastShiftInOut/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/FastShiftInOut/actions/workflows/jsoncheck.yml)
[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/FastShiftInOut.svg)](https://github.com/RobTillaart/FastShiftInOut/issues)

[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/FastShiftInOut/blob/master/LICENSE)
[![GitHub release](https://img.shields.io/github/release/RobTillaart/FastShiftInOut.svg?maxAge=3600)](https://github.com/RobTillaart/FastShiftInOut/releases)
[![PlatformIO Registry](https://badges.registry.platformio.org/packages/robtillaart/library/FastShiftInOut.svg)](https://registry.platformio.org/libraries/robtillaart/FastShiftInOut)


# FastShiftInOut
Expand Down Expand Up @@ -64,12 +67,23 @@ bitOrder = { LSBFIRST, MSBFIRST };
- documentation
- follow FastShiftIn and FastShiftOut

#### should
#### Should


#### could
#### Could

- **void ignoreRead()**
- add Print interface?

#### Wont


## Support

If you appreciate my libraries, you can support the development and maintenance.
Improve the quality of the libraries by providing issues and Pull Requests, or
donate through PayPal or GitHub sponsors.

Thank you,


1 change: 1 addition & 0 deletions keywords.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ FastShiftInOut KEYWORD1
write KEYWORD2

lastWritten KEYWORD2
lastRead KEYWORD2

setBitOrder KEYWORD2
getBitOrder KEYWORD2
Expand Down
4 changes: 2 additions & 2 deletions library.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
"type": "git",
"url": "https://github.com/RobTillaart/FastShiftInOut.git"
},
"version": "0.1.3",
"version": "0.1.4",
"license": "MIT",
"frameworks": "arduino",
"frameworks": "*",
"platforms": "*",
"headers": "FastShiftInOut.h"
}
2 changes: 1 addition & 1 deletion library.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name=FastShiftInOut
version=0.1.3
version=0.1.4
author=Rob Tillaart <rob.tillaart@gmail.com>
maintainer=Rob Tillaart <rob.tillaart@gmail.com>
sentence=Arduino library for (AVR) optimized shiftInOut (simultaneously)
Expand Down

0 comments on commit 9849ba4

Please sign in to comment.