mirror of https://github.com/captn3m0/epicqr.git
Add docs to README
This commit is contained in:
parent
6ba74c15f1
commit
afe71e45cc
14
README.md
14
README.md
|
@ -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.
|
|
@ -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{
|
||||
|
|
Loading…
Reference in New Issue