Add docs to README

This commit is contained in:
Nemo 2024-01-05 23:13:50 +05:30
parent 6ba74c15f1
commit afe71e45cc
2 changed files with 15 additions and 1 deletions

View File

@ -8,6 +8,20 @@ Haxe library to decode a QR code on a modern EPIC Card.
- [ ] Publish 1.0.
- [ ] Publish releases in other languages.
# Usage
```haxe
import eci.EpicQR;
class Main{
static function Main(){
var result = decrypt("Kk0pDEzxYcusltFhJmqL/LLzJtXYHH/a1rJfkK2GjzA1x5jrzaeT1ULEF38L7/lIQ8w3c+H4ePeuVs2HuMYDUg==");
trace(result.epic);
trace(result.id);
}
}
```
## LICENSE
Licensed under MIT. See `LICENCE` file for more details.

View File

@ -7,7 +7,7 @@ import haxe.crypto.padding.Padding;
import haxe.crypto.Base64;
import haxe.Json;
// Test using decrypt("kO5tAxYbv59IbQvmYBOJLw==") == NCS1234566
// Test using decrypt("Kk0pDEzxYcusltFhJmqL/LLzJtXYHH/a1rJfkK2GjzA1x5jrzaeT1ULEF38L7/lIQ8w3c+H4ePeuVs2HuMYDUg==") == NCS1234566
// TODO: Write tests
class EpicQR{