Skip to content

Add usage to readme #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alexchandel wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add usage to readme #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
rust-xdg is a library that makes it easy to follow the standards for directories.

## Usage

```rust
use xdg::XdgDirs;
use std::fs::File;

let dirs = XdgDirs::new();
let data_dir = dirs.want_write_data("AppName");

let mut f = File::create(data_dir.join("data.txt"));
f.write(b"Some data.\n");
```

## License

rust-xdg is primarily distributed under the terms of both the MIT license
Expand Down