Skip to content

Commit 0f0c452

Browse files
author
Zykino
committed
Update Readme
1 parent a354397 commit 0f0c452

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ struct MyConfig {
1616
}
1717

1818
fn main() -> Result<(), ::std::io::Error> {
19-
let cfg: MyConfig = confy::load("my-app-name")?;
19+
let cfg: MyConfig = confy::load("my-app-name", None)?;
2020
dbg!(cfg);
2121
Ok(())
2222
}
@@ -33,7 +33,16 @@ default-features = false
3333
```
3434

3535
## Breakings changes
36+
### Version 0.5.0
37+
* As [`directories`] stopped being maintained we switch to [`directories-next`]. Both crates released a breaking change regarding default configuration path change on macos. For further information check their changelog.
38+
* The base functions `load` and `store` have been added an optionnal parameter in the event multiples configurations are needed, or ones with different filename.
39+
* The default configuration file is now named "default-config" instead of using the application's name. Put the second argument of `load` and `store` to be the same of the first one to keep the previous configuration file.
40+
* It is now possible to save the configuration as toml or as yaml. The configuration's file name's extention depends on the format used.
41+
42+
### Version 0.4.0
3643
Starting with version 0.4.0 the configuration file are stored in the expected place for your system. See the [`directories`] crates for more information.
3744
Before version 0.4.0, the configuration file was written in the current directory.
3845

3946
[`directories`]: https://crates.io/crates/directories
47+
[`directories-next`]: https://crates.io/crates/directories-next
48+

0 commit comments

Comments
 (0)