README.md
1# webbrowser
2
3
4[](https://crates.io/crates/webbrowser)
5[](https://crates.io/crates/webbrowser)
6[](LICENSE-MIT)
7
8Rust library to open URLs in the web browsers available on a platform
9
10Inspired by the [webbrowser](https://docs.python.org/2/library/webbrowser.html) python library
11
12## Documentation
13
14- [API Reference](http://code.rootnet.in/webbrowser-rs/webbrowser/)
15- [Release Notes](CHANGELOG.md)
16
17## Examples
18
19```rust
20use webbrowser;
21
22if webbrowser::open("http://github.com").is_ok() {
23 // ...
24}
25```
26
27Currently state of platform support is:
28
29* macos => default, as well as browsers listed under [Browser](enum.Browser.html)
30* windows => default browser only
31* linux/*bsd => default browser only (uses $BROWSER env var, failing back to xdg-open, gvfs-open, gnome-open, whichever works first)
32* android => default browser only
33* haiku => untested and experimental
34* wasm -> untested and experimental
35* ios => not supported right now
36
37Important note:
38
39* This library requires availability of browsers and a graphical environment during runtime
40* `cargo test` will actually open the browser locally
41
42## License
43
44Licensed under either of
45
46* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
47* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
48
49at your option.
50
51### Contribution
52
53Unless you explicitly state otherwise, any contribution intentionally submitted
54for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
55additional terms or conditions.
56
){kind=link}
){kind=link}
){kind=link}
){kind=link}