Skip to content

Commit

Permalink
Bump version and add migrations guideline
Browse files Browse the repository at this point in the history
  • Loading branch information
Denis Varlakov committed Jan 5, 2024
1 parent df913e8 commit 94f34b7
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 1 deletion.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 1,15 @@
# 3.0.0

v3 release improves `raw` terminal API and enables support of any TTY target.

## 2.0.0 to 3.0.0 guide

Changes are only required if you were using `IntoRawMode` on generic terminals `W: Write`. Now, terminal
is also required to implement [`AsFd` trait][AsFd-trait]. So replacing generic bounds with `W: Write AsFd`
should be sufficient.

[AsFd-trait]: https://doc.rust-lang.org/std/os/fd/trait.AsFd.html

# 1.0.0

Termion 1.0.0 is out! This release is breaking, which is also the reason for the semver bump.
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 1,6 @@
[package]
name = "termion"
version = "2.0.3"
version = "3.0.0"
authors = [
"ticki <[email protected]>",
"gycos <[email protected]>",
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 35,14 @@ This crate is stable.
termion = "*"
```

## 2.0.0 to 3.0.0 guide

Changes are only required if you were using `IntoRawMode` on generic terminals `W: Write`. Now, terminal
is also required to implement [`AsFd` trait][AsFd-trait]. So replacing generic bounds with `W: Write AsFd`
should be sufficient.

[AsFd-trait]: https://doc.rust-lang.org/std/os/fd/trait.AsFd.html

## 1.0.0 to 2.0.0 guide

| 1.0.0 | 2.0.0
Expand Down

0 comments on commit 94f34b7

Please sign in to comment.