Skip to content

Commit

Permalink
doc: Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mcmah309 committed Mar 3, 2024
1 parent 2ff3f25 commit d705b17
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,22 @@ and language-compatible integration.
## Highlights
### Libraries

| [Result] | [Option] | [Cell] | [Slice] | [Iter] | [Panic] | [Typedefs]
| [Result] | [Option] | [Cell] | [Slice] | [Iter] | [Panic] | [Typedefs] |

🔥 **Extensive Extensions:** Dozens of additional extensions with hundreds of methods tailored for Dart. These
extensions are designed for maximum composability, addressing specific scenarios.

🚀 **Dart Friendly:** Dual Support for `Option` and Nullable Types. If a method or extension exists for `Option<T>`,
it's also available for `T?`, offering flexibility and consistency in your coding.
🚀 **Dart Friendly:** Developed with ergonomics in mind. e.g. Dual Support for `Option` and Nullable Types. If a method or extension exists for `Option<T>`,
it's also available for `T?`.

🧪 **Robust Testing:** Every feature tested. Over 300 meaningful tests. Reliability and performance in every feature.
🧪 **Robust Testing:** Every feature tested. Around 400 meaningful tests. Reliability and performance in every feature.

### Official Packages Based Off rust_core
| Library | Description |
| ------- | ----------- |
| [anyhow] | Idiomatic error handling capabilities to make your code safer, more maintainable, and errors easier to debug. |
| [anyhow_logging] | Dynamic logging utility that allows you to log exactly what you want. |
| [rust_std] | Implementation of Rust's standard library in Dart. |
| [tapper] | Extension methods on all types that allow transparent, temporary, inspection/mutation (tapping), transformation (piping), or type conversion. |


Expand All @@ -41,4 +43,6 @@ it's also available for `T?`, offering flexibility and consistency in your codin


[anyhow]: https://pub.dev/packages/anyhow
[anyhow_logging]: https://pub.dev/packages/anyhow_logging
[rust_std]: https://pub.dev/packages/rust_std
[tapper]: https://pub.dev/packages/tapper
4 changes: 2 additions & 2 deletions lib/src/iter/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Iter

A Dart `Iterable` is analogous to a Rust `Iterator`. Dart already has an `Iterator` therefore to avoid confusion,
the Dart version of the Rust iterator is `RIterator`. `RIterator` is a zero cost extension type of `Iterable`. `RIterator`
A Dart `Iterable` is analogous to a Rust `Iterator`. Since Dart already has an `Iterator` class, to avoid confusion,
the Dart implementation of the Rust iterator is `RIterator`. `RIterator` is a zero cost extension type of `Iterable`. `RIterator`
makes working with collections of `rust_core` types and regular Dart types a breeze. e.g.

```dart
Expand Down

0 comments on commit d705b17

Please sign in to comment.