Skip to content

Commit 18678e5

Browse files
authored
Release version 0.3.0 (#7)
1 parent c42e742 commit 18678e5

File tree

5 files changed

+15
-33
lines changed

5 files changed

+15
-33
lines changed

CHANGELOG.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ The format is based on [Keep a Changelog], and this project adheres to [Break Ve
66

77
## [Unreleased]
88

9+
## [0.3.0] - 2025-08-24
10+
911
### Added
1012

1113
* `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
7880

7981
<!-- versions -->
8082

81-
[Unreleased]: https://github.com/aaronmallen/dir_spec/compare/0.2.0...HEAD
83+
[Unreleased]: https://github.com/aaronmallen/dir_spec/compare/0.3.0...HEAD
84+
[0.3.0]: https://github.com/aaronmallen/dir_spec/compare/0.2.0...0.3.0
8285
[0.2.0]: https://github.com/aaronmallen/dir_spec/compare/0.1.0...0.2.0
8386
[0.1.0]: https://github.com/aaronmallen/dir_spec/compare/0.0.1...0.1.0

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "dir_spec"
3-
version = "0.2.0"
3+
version = "0.3.0"
44
edition = "2024"
55
description = "A cross-platform Rust library for resolving XDG and platform-specific directories with proper fallbacks."
66
authors = ["Aaron Allen (@aaronmallen)"]

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# dir_spec
22

3+
[![Crates.io](https://img.shields.io/crates/v/dir_spec?style=for-the-badge&logo=rust)][crate]
4+
[![Documentation](https://img.shields.io/docsrs/dir_spec?style=for-the-badge&logo=docsdotrs)][docsrs]
5+
![Codacy grade](https://img.shields.io/codacy/grade/ae4a182607fb467f9c8b8d92dd500fd4?style=for-the-badge&logo=codacy)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue?style=for-the-badge)](./LICENSE)
7+
38
A cross-platform Rust library for resolving XDG and platform-specific directories with proper fallbacks.
49

510
## Why Another Directory Library?
@@ -22,7 +27,7 @@ Add this to your `Cargo.toml`:
2227

2328
```toml
2429
[dependencies]
25-
dir_spec = "0.2.0"
30+
dir_spec = "0.3.0"
2631
```
2732

2833
Basic usage:
@@ -183,7 +188,9 @@ Contributions are welcome! Please ensure:
183188
- [Apple File System Programming Guide][apple-guide]
184189
- [Windows Known Folder IDs][windows-folders]
185190

186-
[xdg-spec]: https://specifications.freedesktop.org/basedir-spec/latest/
187191
[apple-guide]:
188192
https://developer.apple.com/library/archive/documentation/FileManagement/Conceptual/FileSystemProgrammingGuide/
193+
[crate]: https://crates.io/crates/dir_spec
194+
[docsrs]: https://docs.rs/dir_spec
195+
[xdg-spec]: https://specifications.freedesktop.org/basedir-spec/latest/
189196
[windows-folders]: https://learn.microsoft.com/en-us/windows/win32/shell/knownfolderid

docs/CONTRIBUTING.md

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -178,34 +178,6 @@ mise run ci
178178
git push origin feature/your-feature-name
179179
```
180180

181-
## Project Structure
182-
183-
```text
184-
dir_spec/
185-
├── src/
186-
│ ├── lib.rs # Public API exports
187-
│ └── dir.rs # Core directory resolution logic
188-
├── bin/
189-
│ ├── audit # Dependency security and update checks
190-
│ ├── build # Build the project
191-
│ ├── ci # Run all CI checks
192-
│ ├── clean # Clean build artifacts
193-
│ ├── lint/
194-
│ │ ├── _default # Run all lint checks
195-
│ │ ├── check/
196-
│ │ │ ├── markdown # Check markdown formatting
197-
│ │ │ └── rust # Check rust formatting/linting
198-
│ │ └── fix/
199-
│ │ ├── _default # Auto-fix all issues
200-
│ │ ├── markdown # Auto-fix markdown
201-
│ │ └── rust # Auto-fix rust formatting
202-
│ ├── setup # Install development dependencies
203-
│ └── test # Run tests
204-
├── rust-toolchain.toml # Rust version specification
205-
├── rustfmt.toml # Code formatting rules
206-
└── Cargo.toml # Project configuration
207-
```
208-
209181
## Testing Guidelines
210182

211183
### Platform Coverage

0 commit comments

Comments
 (0)