summaryrefslogtreecommitdiffstats
path: root/src/tools/cargo/crates/credential/cargo-credential/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-18 02:49:50 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-18 02:49:50 +0000
commit9835e2ae736235810b4ea1c162ca5e65c547e770 (patch)
tree3fcebf40ed70e581d776a8a4c65923e8ec20e026 /src/tools/cargo/crates/credential/cargo-credential/README.md
parentReleasing progress-linux version 1.70.0+dfsg2-1~progress7.99u1. (diff)
downloadrustc-9835e2ae736235810b4ea1c162ca5e65c547e770.tar.xz
rustc-9835e2ae736235810b4ea1c162ca5e65c547e770.zip
Merging upstream version 1.71.1+dfsg1.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/tools/cargo/crates/credential/cargo-credential/README.md')
-rw-r--r--src/tools/cargo/crates/credential/cargo-credential/README.md41
1 files changed, 0 insertions, 41 deletions
diff --git a/src/tools/cargo/crates/credential/cargo-credential/README.md b/src/tools/cargo/crates/credential/cargo-credential/README.md
deleted file mode 100644
index 1f75e598a..000000000
--- a/src/tools/cargo/crates/credential/cargo-credential/README.md
+++ /dev/null
@@ -1,41 +0,0 @@
-# cargo-credential
-
-This package is a library to assist writing a Cargo credential helper, which
-provides an interface to store tokens for authorizing access to a registry
-such as https://crates.io/.
-
-Documentation about credential processes may be found at
-https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#credential-process
-
-Example implementations may be found at
-https://github.com/rust-lang/cargo/tree/master/crates/credential
-
-## Usage
-
-Create a Cargo project with this as a dependency:
-
-```toml
-# Add this to your Cargo.toml:
-
-[dependencies]
-cargo-credential = "0.1"
-```
-
-And then include a `main.rs` binary which implements the `Credential` trait, and calls
-the `main` function which will call the appropriate method of the trait:
-
-```rust
-// src/main.rs
-
-use cargo_credential::{Credential, Error};
-
-struct MyCredential;
-
-impl Credential for MyCredential {
- /// implement trait methods here...
-}
-
-fn main() {
- cargo_credential::main(MyCredential);
-}
-```