aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aa181fa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# 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)
+
+Rust Crate Template is a Rust crate template.
+
+## Usage
+
+### Add Rust Crate Template as a dependency
+
+```toml
+# Cargo.toml
+
+[dependencies]
+rust-crate-template = "0.1.0"
+```
+
+## Examples
+
+Examples can be found within the
+[`examples/`](https://github.com/Fuwn/rust-crate-template/tree/main/examples) directory.
+
+## License
+
+This project is licensed with the
+[GNU General Public License v3.0](https://github.com/Fuwn/rust-crate-template/blob/main/LICENSE).