Skip to content

Commit

Permalink
updates readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kozw committed Mar 12, 2021
1 parent 5677c9c commit 6ecc1e1
Showing 1 changed file with 2 additions and 5 deletions.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ In your flutter project add the dependency:
```yml
dependencies:
...
flutter_sodium: ^0.1.6
flutter_sodium: ^0.2.0
```
Import the plugin and initialize it. Sodium.init() initializes the plugin and should be called before any other function provided by flutter_sodium.
Expand Down Expand Up @@ -62,7 +62,7 @@ The flutter_sodium plugin implements the following libsodium APIs:
- randombytes
- sodium_version

API coverage is not 100% complete, track the progress in issue #35.
API coverage is not 100% complete, track the progress in [issue #61](https://github.com/firstfloorsoftware/flutter_sodium/issues/61)

## Dart APIs
The plugin includes a core API that maps native libsodium functions 1:1 to Dart equivalents. The core API is available in the class [`Sodium`](https://github.com/firstfloorsoftware/flutter_sodium/blob/master/lib/flutter_sodium.dart). Dart naming conventions are used for core API function names. A native libsodium function such as `crypto_pwhash_str`, is available in flutter as `Sodium.cryptoPwhashStr`.
Expand All @@ -86,6 +86,3 @@ final str = await compute(PasswordHash.hashStringStorageModerate, pw);
print(str);
```

## Known issues
- Previous incarnations of flutter_sodium used platform channels for native interop. The latest version has been rewritten to take full advantage of Dart FFI. FFI offers fast native interop and is the obvious choice for flutter_sodium. One minor problem, FFI is still in beta and its API may change. This may affect flutter_sodium.

0 comments on commit 6ecc1e1

Please sign in to comment.