Skip to content

Commit

Permalink
Fix typo, link to docs, update docs
Browse files Browse the repository at this point in the history
The link to docs.rs needn't include `/crate/` which links to a
page about the crate rather than directly to the documentation.

Update crate docs with correct MSRV and platform support.
  • Loading branch information
waywardmonkeys committed Jul 25, 2024
1 parent b15c997 commit 1d82ef4
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name = "terminal_size"
version = "0.3.0"
authors = ["Andrew Chin <achin@eminence32.net>"]
description = "Gets the size of your Linux or Windows terminal"
documentation = "https://docs.rs/crate/terminal_size"
documentation = "https://docs.rs/terminal_size"
repository = "https://github.com/eminence/terminal-size"
keywords = ["terminal", "console", "term", "size", "dimensions"]
license = "MIT OR Apache-2.0"
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ terminal-size
=============


[Documention](https://docs.rs/crate/terminal_size)
[Documentation](https://docs.rs/terminal_size)


Rust library to getting the size of your terminal.
Rust library for getting the size of your terminal.

Works on Linux, MacOS, Windows, and illumos.
Works on Linux, macOS, Windows, and illumos.

```rust
use terminal_size::{Width, Height, terminal_size};
Expand All @@ -22,7 +22,7 @@ if let Some((Width(w), Height(h))) = size {

## Minimum Rust Version

This crate requires a minimum rust version of 1.63.0 (2022-08-11)
This crate requires a minimum Rust version of 1.63.0 (2022-08-11).

## License

Expand Down
4 changes: 2 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
//! A simple utility for getting the size of a terminal.
//!
//! Supports both Linux, MacOS, and Windows.
//! Works on Linux, macOS, Windows, and illumos.
//!
//! This crate requires a minimum rust version of 1.48.0 (2020-11-19)
//! This crate requires a minimum Rust version of 1.63.0 (2022-08-11).
//!
//! # Example
//!
Expand Down

0 comments on commit 1d82ef4

Please sign in to comment.