Skip to content

Commit 5cbde48

Browse files
Update README with migration and performance details
1 parent f70767f commit 5cbde48

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ This is a heavily adapted fork of the excellent [somesocks/lua-lockbox](https://
3030
Upstream lua-lockbox is a fantastic general-purpose reference, but has seen low activity and is seeking new maintainers.
3131

3232
### Quick usage in an Edge driver
33-
33+
Migration from lua-lockbox is a drop in other than replacing lockbox with crypto. The API remains compatible.
3434
```lua
3535
local Crypto = require "crypto"
3636

@@ -59,7 +59,7 @@ local mac = hmac()
5959
|---------------------------------|--------------------------------------------|---------------------------------------------------|
6060
| **Performance** | **External bit library overhead** | **Native bitwise operators** (8.5% faster avg) |
6161
| Lua version | Broad compat (5.1+ with fallbacks) | ≥ 5.3 (native bitwise, integers) |
62-
| Bitwise operations | Dynamic require (bit/bit32/numberlua) | Native `& | ~ << >>` operators |
62+
| Bitwise operations | Dynamic require (bit/bit32/numberlua) | Native operators |
6363
| Rotations | Polyfill / compatibility layer | Native shift + 32-bit mask |
6464
| CI | Travis | GitHub Actions + direct Lua 5.3 testing |
6565
| Test suite | Original RFC vectors + edge cases | Fixed vectors, pruned problematic tests, large-data added |
@@ -75,4 +75,4 @@ If this library saves you time on your Edge driver, consider sponsoring developm
7575
MIT (same as upstream)
7676

7777
Original Implementation © 2015–2024 somesocks
78-
Adaptations & SmartThings Edge Optimizations © 2022–2026 blueyetisoftware (BlueYeti Software Inc.)
78+
Adaptations & SmartThings Edge Optimizations © 2022–2026 blueyetisoftware (BlueYeti Software Inc.)

0 commit comments

Comments
 (0)