Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
baoyachi committed Jul 31, 2021
1 parent 154777c commit faf2038
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "shadow-rs"
version = "0.6.2"
version = "0.6.3"
authors = ["baoyachi <[email protected]>"]
edition = "2018"
description = "A build-time information stored in your rust project"
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,8 @@ fn main() {
println!("{}", build::BUILD_TIME_2822); // time when start build occurred by rfc2822, e.g. 'Thu, 24 Jun 2021 21:33:59 +0800'
println!("{}", build::BUILD_TIME_3339); // time when start build occurred by rfc3339, e.g. '2021-06-24T21:33:59.972494+08:00'
println!("{}", build::BUILD_RUST_CHANNEL); // e.g. 'debug'
println!("{}", build::GIT_CLEAN); // e.g. 'true'
println!("{}", build::GIT_STATUS_FILE); // e.g. '* src/lib.rs (dirty)'
}
```

Expand Down Expand Up @@ -165,6 +167,8 @@ with [`clap`](https://github.com/baoyachi/shadow-rs/blob/master/example_shadow/s
| BUILD_TIME_2822 | Thu, 24 Jun 2021 21:33:59 +0800 |
| BUILD_TIME_3339 | 2021-06-24T15:53:55+08:00 |
| BUILD_RUST_CHANNEL | debug/release |
| GIT_CLEAN | true/false |
| GIT_STATUS_FILE | * src/lib.rs (dirty) |

If you have any questions, please create an [issue](https://github.com/baoyachi/shadow-rs/issues/new) so we may improve
the documentation where it may be unclear.
Expand Down
4 changes: 4 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@
//! pub const CARGO_VERSION :&str = "cargo 1.45.0 (744bd1fbb 2020-06-15)";
//! pub const BUILD_OS :&str = "macos-x86_64";
//! pub const COMMIT_HASH :&str = "386741540d73c194a3028b96b92fdeb53ca2788a";
//! pub const GIT_CLEAN :bool = true;
//! pub const GIT_STATUS_FILE :&str = "* src/lib.rs (dirty)";
//! ```
//! # Setup Guide
//!
Expand Down Expand Up @@ -123,6 +125,8 @@
//! println!("{}",build::PROJECT_NAME);//shadow-rs
//! println!("{}",build::BUILD_TIME);//2020-08-16 14:50:25
//! println!("{}",build::BUILD_RUST_CHANNEL);//debug
//! println!("{}",build::GIT_CLEAN);//false
//! println!("{}",build::GIT_STATUS_FILE);//* src/lib.rs (dirty)
//! }
//!```
//!
Expand Down

0 comments on commit faf2038

Please sign in to comment.