Skip to content

Commit a635477

Browse files
committed
Better package description
1 parent a5d7ef5 commit a635477

File tree

2 files changed

+8
-9
lines changed

2 files changed

+8
-9
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name = "unix_mode"
33
version = "0.1.4-pre"
44
authors = ["Martin Pool <[email protected]>"]
55
edition = "2018"
6-
description = "Decode Unix file mode bits (even on non-Unix platforms)"
6+
description = "Decode, interpret, and display Unix file mode bits (even on non-Unix platforms)"
77
license = "Apache-2.0"
88
repository = "https://github.com/sourcefrog/unix_mode"
99

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
# unix\_mode Rust library
1+
# unix_mode: Decode, interpret, and display Unix file mode bits
22

33
[![crates.io](https://img.shields.io/crates/v/unix_mode.svg)](https://crates.io/crates/unix_mode)
44
[![docs.rs](https://docs.rs/unix_mode/badge.svg)](https://docs.rs/unix_mode)
55
[![Tests](https://github.com/sourcefrog/unix_mode/workflows/rust/badge.svg)](https://github.com/sourcefrog/unix_mode/actions?query=workflow%3Arust)
66

7-
This library provides functions to decode and print Unix mode bits /
8-
permissions, even on non-Unix platforms.
7+
`unix_mode` provides functions to decode, interpret, and display Unix mode bits
8+
and permissions, even on non-Unix platforms.
99

1010
On Unix, decoding is supported by `std::os::unix::fs` in the standard library,
11-
but this crate adds a function to render them in the format used by `ls -l`,
12-
and to understand the file type and permissions.
11+
but this crate adds a function to render them in the format used by `ls -l`, and
12+
to understand the file type and permissions.
1313

1414
assert_eq!(unix_mode::to_string(0o0040755), "drwxr-xr-x");
1515
assert_eq!(unix_mode::to_string(0o0100640), "-rw-r-----");
16-
16+
1717
assert_eq!(unix_mode::is_symlink(0o0040755), false);
1818

1919
For API documentation see <https://docs.rs/unix_mode>.
@@ -26,8 +26,7 @@ Apache-2.0.
2626

2727
Patches are very welcome.
2828

29-
Please read the
30-
[contribution guidelines](CONTRIBUTING.md) and
29+
Please read the [contribution guidelines](CONTRIBUTING.md) and
3130
[code of conduct](CODE_OF_CONDUCT.md).
3231

3332
## Disclaimer

0 commit comments

Comments
 (0)