From 18678e5b27047a2f779d27b37bb159c044a04fdb Mon Sep 17 00:00:00 2001 From: Aaron Allen Date: Sun, 24 Aug 2025 17:21:58 -0500 Subject: [PATCH] Release version 0.3.0 (#7) --- CHANGELOG.md | 5 ++++- Cargo.lock | 2 +- Cargo.toml | 2 +- README.md | 11 +++++++++-- docs/CONTRIBUTING.md | 28 ---------------------------- 5 files changed, 15 insertions(+), 33 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 26947ad..eaf1417 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,8 @@ The format is based on [Keep a Changelog], and this project adheres to [Break Ve ## [Unreleased] +## [0.3.0] - 2025-08-24 + ### Added * `config_local()` - Returns user's local (non-roaming) config directory. On Windows uses `%LOCALAPPDATA%`, identical @@ -78,6 +80,7 @@ The format is based on [Keep a Changelog], and this project adheres to [Break Ve -[Unreleased]: https://github.com/aaronmallen/dir_spec/compare/0.2.0...HEAD +[Unreleased]: https://github.com/aaronmallen/dir_spec/compare/0.3.0...HEAD +[0.3.0]: https://github.com/aaronmallen/dir_spec/compare/0.2.0...0.3.0 [0.2.0]: https://github.com/aaronmallen/dir_spec/compare/0.1.0...0.2.0 [0.1.0]: https://github.com/aaronmallen/dir_spec/compare/0.0.1...0.1.0 diff --git a/Cargo.lock b/Cargo.lock index 8db928a..f060819 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -22,7 +22,7 @@ checksum = "2fd1289c04a9ea8cb22300a459a72a385d7c73d3259e2ed7dcb2af674838cfa9" [[package]] name = "dir_spec" -version = "0.2.0" +version = "0.3.0" dependencies = [ "temp-env", ] diff --git a/Cargo.toml b/Cargo.toml index 359eb58..4609b11 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "dir_spec" -version = "0.2.0" +version = "0.3.0" edition = "2024" description = "A cross-platform Rust library for resolving XDG and platform-specific directories with proper fallbacks." authors = ["Aaron Allen (@aaronmallen)"] diff --git a/README.md b/README.md index c7701b0..bd0df0f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ # dir_spec +[![Crates.io](https://img.shields.io/crates/v/dir_spec?style=for-the-badge&logo=rust)][crate] +[![Documentation](https://img.shields.io/docsrs/dir_spec?style=for-the-badge&logo=docsdotrs)][docsrs] +![Codacy grade](https://img.shields.io/codacy/grade/ae4a182607fb467f9c8b8d92dd500fd4?style=for-the-badge&logo=codacy) +[![License: MIT](https://img.shields.io/badge/License-MIT-blue?style=for-the-badge)](./LICENSE) + A cross-platform Rust library for resolving XDG and platform-specific directories with proper fallbacks. ## Why Another Directory Library? @@ -22,7 +27,7 @@ Add this to your `Cargo.toml`: ```toml [dependencies] -dir_spec = "0.2.0" +dir_spec = "0.3.0" ``` Basic usage: @@ -183,7 +188,9 @@ Contributions are welcome! Please ensure: - [Apple File System Programming Guide][apple-guide] - [Windows Known Folder IDs][windows-folders] -[xdg-spec]: https://specifications.freedesktop.org/basedir-spec/latest/ [apple-guide]: https://developer.apple.com/library/archive/documentation/FileManagement/Conceptual/FileSystemProgrammingGuide/ +[crate]: https://crates.io/crates/dir_spec +[docsrs]: https://docs.rs/dir_spec +[xdg-spec]: https://specifications.freedesktop.org/basedir-spec/latest/ [windows-folders]: https://learn.microsoft.com/en-us/windows/win32/shell/knownfolderid diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 740bf3a..85dc731 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -178,34 +178,6 @@ mise run ci git push origin feature/your-feature-name ``` -## Project Structure - -```text -dir_spec/ -├── src/ -│ ├── lib.rs # Public API exports -│ └── dir.rs # Core directory resolution logic -├── bin/ -│ ├── audit # Dependency security and update checks -│ ├── build # Build the project -│ ├── ci # Run all CI checks -│ ├── clean # Clean build artifacts -│ ├── lint/ -│ │ ├── _default # Run all lint checks -│ │ ├── check/ -│ │ │ ├── markdown # Check markdown formatting -│ │ │ └── rust # Check rust formatting/linting -│ │ └── fix/ -│ │ ├── _default # Auto-fix all issues -│ │ ├── markdown # Auto-fix markdown -│ │ └── rust # Auto-fix rust formatting -│ ├── setup # Install development dependencies -│ └── test # Run tests -├── rust-toolchain.toml # Rust version specification -├── rustfmt.toml # Code formatting rules -└── Cargo.toml # Project configuration -``` - ## Testing Guidelines ### Platform Coverage -- 2.51.2