From b31dc7a9cdaf565ee98c8199dd0fe85f4eac3f2a Mon Sep 17 00:00:00 2001 From: Fuwn Date: Thu, 28 Apr 2022 18:33:51 -0700 Subject: docs(readme): update template usage info --- Cargo.toml | 2 +- README.md | 6 +++++- src/lib.rs | 8 ++++++-- 3 files changed, 12 insertions(+), 4 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 87e412f..1cca16b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,7 +2,7 @@ [package] name = "rust-crate-template" -version = "0.1.0" +version = "0.1.1" authors = ["Fuwn "] edition = "2021" description = "A Rust crate template" diff --git a/README.md b/README.md index aa181fa..9559d65 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,17 @@ Rust Crate Template is a Rust crate template. ## Usage +> Using this as a template? Try +> `cargo generate --git https://github.com/Fuwn/rust-crate-template` with +> [`cargo-generate`](https://github.com/cargo-generate/cargo-generate)! + ### Add Rust Crate Template as a dependency ```toml # Cargo.toml [dependencies] -rust-crate-template = "0.1.0" +rust-crate-template = "0.1.1" ``` ## Examples diff --git a/src/lib.rs b/src/lib.rs index e2d3000..cff56bb 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -17,7 +17,7 @@ // SPDX-License-Identifier: GPL-3.0-only //! # Rust Crate Template -//! ///! +//! //! [![crates.io](https://img.shields.io/crates/v/rust-crate-template.svg)](https://crates.io/crates/rust-crate-template) //! [![docs.rs](https://docs.rs/rust-crate-template/badge.svg)](https://docs.rs/rust-crate-template) //! [![github.com](https://github.com/Fuwn/rust-crate-template/actions/workflows/check.yaml/badge.svg?branch=main)](https://github.com/Fuwn/rust-crate-template/actions/workflows/check.yaml) @@ -26,13 +26,17 @@ //! //! ## Usage //! +//! > Using this as a template? Try +//! > `cargo generate --git https://github.com/Fuwn/rust-crate-template` with +//! > [`cargo-generate`](https://github.com/cargo-generate/cargo-generate)! +//! //! ### Add Rust Crate Template as a dependency //! //! ```toml //! # Cargo.toml //! //! [dependencies] -//! rust-crate-template = "0.1.0" +//! rust-crate-template = "0.1.1" //! ``` //! //! ## Examples -- cgit v1.2.3