Skip to content

Commit 1324e7d

Browse files
committed
update dargon2_flutter readme
1 parent 2daf80f commit 1324e7d

File tree

3 files changed

+22
-13
lines changed

3 files changed

+22
-13
lines changed

.idea/workspace.xml

Lines changed: 12 additions & 12 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dargon2_flutter/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
# dargon2_flutter
2+
[![dargon2_flutter](https://github.com/tmthecoder/dargon2/actions/workflows/dargon2_flutter_tests.yml/badge.svg?branch=main)](https://github.com/tmthecoder/dargon2/actions/workflows/dargon2_flutter_tests.yml)
3+
[![pub package](https://img.shields.io/pub/v/dargon2_flutter.svg)](https://pub.dev/packages/dargon2_flutter)
24
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
35

46
A plugin to handle dart:ffi integrations for iOS and Android for argon2 password hashing in Flutter Applications.
@@ -24,6 +26,12 @@ If you're using Objective-C for the iOS portion of your application (created wit
2426
- (**This is the Important Step**) Select `Create Bridging Header` when the prompt comes up
2527
- You don't have to add anything to that swift file or the bridging header, but it needs to be there along with the bridging header in order for the plugin to compile correctly for iOS
2628

29+
## Desktop (Linux)
30+
When building on Linux utilizng `dargon2_flutter`, the C standard library must be installed.
31+
I recommend ensuring it's installed by running `sudo apt install build-essential` or your distro's equivalent
32+
33+
Otherwise, the underlying C implementation will not build successfully, causing a cascading build failure.
34+
2735
## Usage
2836

2937
High-level hashing and verification (for direct hashing & verification of byte arrays, check the example on [dargon2])
@@ -85,7 +93,7 @@ Please mark all dargon2_flutter issues with `[dargon2_flutter]` prepended to the
8593
- The C implementation of [Argon2] is licensed under a dual [Apache and CC0 License]
8694
- [hash-wasm] is licensed under the [MIT License](https://github.com/Daninet/hash-wasm/blob/master/LICENSE)
8795

88-
[MIT License]: https://github.com/tmthecoder/dargon2/blob/main/dargon2_flutter/LICENSE
96+
[MIT License]: ../LICENSE
8997

9098
[Argon2]: https://github.com/P-H-C/phc-winner-argon2
9199

dargon2_flutter/dargon2_flutter/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# dargon2_flutter
22
[![dargon2_flutter](https://github.com/tmthecoder/dargon2/actions/workflows/dargon2_flutter_tests.yml/badge.svg?branch=main)](https://github.com/tmthecoder/dargon2/actions/workflows/dargon2_flutter_tests.yml)
3+
[![pub package](https://img.shields.io/pub/v/dargon2_flutter.svg)](https://pub.dev/packages/dargon2_flutter)
34
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
45

56
A plugin to handle dart:ffi integrations for iOS and Android for argon2 password hashing in Flutter Applications.

0 commit comments

Comments
 (0)