chore: remove rocket example from members

This commit is contained in:
Dmitriy Pleshevskiy 2019-12-31 09:32:45 +03:00
parent c890aec37f
commit 57598a876d
4 changed files with 26 additions and 3 deletions

View file

@ -3,5 +3,5 @@ members = [
"itconfig", "itconfig",
"itconfig_tests", "itconfig_tests",
"examples/diesel", "examples/diesel",
"examples/rocket", # "examples/rocket",
] ]

View file

@ -1,5 +1,5 @@
[package] [package]
name = "rocket" name = "itconfig-rocket-example"
version = "0.1.0" version = "0.1.0"
authors = ["Dmitriy Pleshevskiy <dmitriy@ideascup.me>"] authors = ["Dmitriy Pleshevskiy <dmitriy@ideascup.me>"]
edition = "2018" edition = "2018"

23
examples/rocket/README.md Normal file
View file

@ -0,0 +1,23 @@
# itconfig rocket example
### Installation
To install a nightly version of Rust, we recommend using rustup. Install rustup by following the instructions on its website. Once rustup is installed, configure Rust nightly as your default toolchain by running the command:
`rustup default nightly`
If you prefer, once we setup a project directory in the following section, you can use per-directory overrides to use the nightly version only for your Rocket project by running the following command in the directory:
`rustup override set nightly`
### Usage
```bash
cd examples/rocket
cargo run
```

View file

@ -192,7 +192,7 @@ impl From<EnvValue> for String {
/// -------------------------------------------- /// --------------------------------------------
/// ///
/// ```rust /// ```rust
/// pub fn init(); /// pub fn init() {}
/// ``` /// ```
/// ///
/// Run this at the main function for check all required variables without default value. /// Run this at the main function for check all required variables without default value.