update README

This commit is contained in:
afonya2 2025-05-17 17:44:17 +02:00
parent ff4bf3525d
commit d17ea51357
Signed by: afonya
GPG key ID: EBB9C4CAFAAFB2DC

View file

@ -9,8 +9,8 @@ console.log(hash)
console.log(IGA.verifyHash("test", hash))
```
## Functions
- `hash(input: string, salt: number = 0, iterations: number = 32, len: number = 32, seed?: number): string` - creates a "hash" from the input
- `verifyHash(input: string, inHash: string, salt: number = 0, iterations: number = 32, len: number = 32): verifyOut` - verifies the "hash", returns `{ valid: bool, reason: string }`
- `hash(input: string, salt: number = 0, len: number = 32, seed?: number): string` - creates a "hash" from the input
- `verifyHash(input: string, inHash: string, salt: number = 0, len: number = 32): verifyOut` - verifies the "hash", returns `{ valid: bool, reason: string }`
## DO NOT USE FOR SECURE PROJECTS
- It's security has not been verified yet.
- It can't be reverted but it might collide.