Skip to content

Commit

Permalink
Spell check.
Browse files Browse the repository at this point in the history
  • Loading branch information
notpeter committed Apr 22, 2024
1 parent 1ddd3af commit 803d4d8
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
@@ -1,6 +1,6 @@
[package]
name = "env_home"
description = "A simple library to get the user's home directory in a cross-platform way."
description = "Get the user home directory in a cross-platform way."
authors = ["Peter Tripp <peter.tripp@gmail.com>"]
homepage = "https://github.com/notpeter/env-home"
repository = "https://github.com/notpeter/env-home"
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# env_home rust crate

A pure-Rust crate for determining user home directories via environment variables
in a platform independent manor with no external dependencies.
in a platform independent manner with no external dependencies.

Checks `HOME` on Unix and `USERPROFILE` on Windows.
Check `HOME` on Unix and `USERPROFILE` on Windows.

## Description

env_home is a general purpose crate for determining the current user
home directory via enviornment variables.
home directory via environment variables.

It can be used as drop-in replacement for
[`std::env::home_dir` (deprecated)](https://doc.rust-lang.org/std/env/fn.home_dir.html)
from the rust standard library.

Unlike `std::env::home_dir` this crate **only** looks at enviornment variables
Unlike `std::env::home_dir` this crate **only** looks at environment variables
and does attempt to fallback on platform specific APIs. As a result implementation
of `env_home_dir` is [very simple](src/lib.rs) with no dependencies on other crates.

Expand All @@ -25,7 +25,7 @@ or Python's [Path.home()](https://docs.python.org/3/library/pathlib.html#pathlib

The API of this crate is a single function `env_home_dir`
which attempts to fetch a user's home directory from environment variables
in a platform independant way supporting Windows and Unix (Linux/MacOS/BSD/WSL, etc).
in a platform independent way supporting Windows and Unix (Linux/MacOS/BSD/WSL, etc).

| Platform | Environment Variable | Example |
| --------------------------------- | -------------------- | ----------------- |
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Copyright 2024 Peter Tripp
//! env_home is a general purpose crate for determining the current user
//! home directory in a platform independant manor via enviornment variables.
//! home directory in a platform independant manner via enviornment variables.
//!
//! This crate is implemented in pure-rust and has no external dependencies.
//!
Expand Down

0 comments on commit 803d4d8

Please sign in to comment.