From 1d82ef49ea354875b6a8f6e9ec0cbe97aef98b74 Mon Sep 17 00:00:00 2001 From: Bruce Mitchener Date: Thu, 25 Jul 2024 11:57:03 +0700 Subject: [PATCH] Fix typo, link to docs, update docs 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. --- Cargo.toml | 2 +- README.md | 8 ++++---- src/lib.rs | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index cdead90..eef61b0 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,7 +3,7 @@ name = "terminal_size" version = "0.3.0" authors = ["Andrew Chin "] 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" diff --git a/README.md b/README.md index 30e8872..6674616 100644 --- a/README.md +++ b/README.md @@ -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}; @@ -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 diff --git a/src/lib.rs b/src/lib.rs index 6f8990c..27661ff 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -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 //!