Skip to content

Commit

Permalink
Improves README.md files.
Browse files Browse the repository at this point in the history
  • Loading branch information
terrier989 committed Jul 18, 2021
1 parent 7049fd2 commit d0d83ea
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 15 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
Cryptographic packages for [Dart](https://dart.dev) / [Flutter](https://flutter.dev) developers.
Open-sourced under the [Apache License 2.0](LICENSE).

Maintained by Gohilla Ltd. Licensed under the [Apache License 2.0](LICENSE).

## Packages
* [cryptography](cryptography)
* Cryptography API for Dart / Flutter.
Expand Down
18 changes: 11 additions & 7 deletions cryptography/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
# Overview
Popular cryptographic algorithms for [Dart](https://dart.dev) / [Flutter](https://flutter.dev)
developers.

Maintained by Gohilla Ltd. Licensed under the [Apache License 2.0](LICENSE).

This package is:
Expand All @@ -25,10 +26,6 @@ Any feedback, issue reports, or pull requests are appreciated!
* Android / iOS cryptography support.
* [jwk](https://pub.dev/packages/jwk)
* JWK (JSON Web Key) support.
* [kms](https://pub.dev/packages/kms)
* KMS (Key Management Service) support.
* [noise_protocol](https://pub.dev/packages/noise_protocol)
* Noise handshake support.

# Key concepts
## Key classes
Expand Down Expand Up @@ -174,10 +171,10 @@ We wrote the following three implementations of `Cryptography`:
* Sha256
* Sha384
* Sha512
* [FlutterCryptography](https://pub.dev/documentation/cryptography_flutter/latest/cryptography_flutter/FlutterCryptography-class.html)
* [FlutterCryptography](https://pub.dev/documentation/cryptography_flutter/latest/cryptography/FlutterCryptography-class.html)
* A Flutter plugin available in [cryptography_flutter](https://pub.dev/packages/cryptography_flutter).
* Extends _BrowserCryptography_.
* Enabled with [FlutterCryptography.enable()](https://pub.dev/documentation/cryptography_flutter/latest/cryptography_flutter/FlutterCryptography/enable.html).
* Enabled with [FlutterCryptography.enable()](https://pub.dev/documentation/cryptography_flutter/latest/cryptography/FlutterCryptography/enable.html).
* In Android, _FlutterCryptography_ gives:
* AesCbc
* AesCtr
Expand All @@ -193,7 +190,14 @@ We wrote the following three implementations of `Cryptography`:
In _pubspec.yaml_:
```yaml
dependencies:
cryptography: ^2.0.0
cryptography: ^2.0.2
```
If you use Flutter, we recommend that you also add [cryptography_flutter](https://pub.dev/packages/cryptography_flutter):
```yaml
dependencies:
cryptography: ^2.0.2
cryptography_flutter: ^2.0.1
```
# Examples
Expand Down
18 changes: 10 additions & 8 deletions cryptography_flutter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,18 @@ This is a version of the package [cryptography](https://pub.dev/packages/cryptog
optimizes performance of some cryptographic algorithms by using native APIs of Android, iOS, and
Mac OS X. You must use asynchronous methods to get the performance boost.

Maintained by Gohilla Ltd. Licensed under the [Apache License 2.0](LICENSE).

## Optimized algorithms
### In Android
* AES_CBC
* AES_CTR
* AES_GCM
* CHACHA20_POLY1305_AEAD
* [AesCbc()](https://pub.dev/documentation/cryptography/latest/cryptography/AesCbc-class.html)
* [AesCtr()](https://pub.dev/documentation/cryptography/latest/cryptography/AesCtr-class.html)
* [AesGcm()](https://pub.dev/documentation/cryptography/latest/cryptography/AesGcm-class.html)
* [Chacha20.poly1305()](https://pub.dev/documentation/cryptography/latest/cryptography/Chacha20-class.html)

### In iOS and Mac OS X
* AES_GCM
* CHACHA20_POLY1305_AEAD
* [AesGcm()](https://pub.dev/documentation/cryptography/latest/cryptography/AesGcm-class.html)
* [Chacha20.poly1305()](https://pub.dev/documentation/cryptography/latest/cryptography/Chacha20-class.html)

## Links
* [Github project](https://github.com/dint-dev/cryptography)
Expand All @@ -28,8 +30,8 @@ Mac OS X. You must use asynchronous methods to get the performance boost.
In _pubspec.yaml_:
```yaml
dependencies:
cryptography: ^2.0.0
cryptography_flutter: ^2.0.0
cryptography: ^2.0.2
cryptography_flutter: ^2.0.1
```
Then just use:
Expand Down
2 changes: 2 additions & 0 deletions jwk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
JWK (JSON Web Key) encoding and decoding. Designed to be used with
[package:cryptography](https://pub.dev/packages/cryptography).

Maintained by Gohilla Ltd. Licensed under the [Apache License 2.0](LICENSE).

# Examples
## Encoding KeyPair
```dart
Expand Down

0 comments on commit d0d83ea

Please sign in to comment.