Skip to content

Commit

Permalink
docs: Update simple-async README.md 📚
Browse files Browse the repository at this point in the history
  • Loading branch information
kdheepak committed Jan 14, 2024
1 parent 4fd82be commit b757714
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions simple-async/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Simple Async template

The simple template will create the following project structure:
This simple async template will create the following project structure:

```text
src/
Expand All @@ -13,10 +13,12 @@ src/
└── ui.rs -> renders the widgets / UI
```

This is identical to the simple template but has `async` events out of the box with `tokio` and
This is identical to the [simple] template but has `async` events out of the box with `tokio` and
`crossterm`'s `EventStream`.

Here's the exact diff if you want to convert your own code to async:
[simple](../simple/)

Here's a `diff` if you use as reference if want to convert your own code to `async`:

**`./Cargo.toml`**

Expand All @@ -33,7 +35,6 @@ Here's the exact diff if you want to convert your own code to async:
+futures = "0.3.30"
+ratatui = "0.25.0"
+tokio = { version = "1.35.1", features = ["full"] }
+tokio-util = "0.7.10"
```

**`./src/event.rs`**
Expand Down

0 comments on commit b757714

Please sign in to comment.