diff --git a/README.md b/README.md index d4b4fb2..eb73780 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,37 @@ -# padder -String formatting done right. +
+
+
+
+
+ +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +[![Crates.io (latest)](https://img.shields.io/crates/v/padder)](https://crates.io/crates/padder) +[![codecov](https://codecov.io/gh/firelink-data/padder/graph/badge.svg?token=64QB0J4QMV)](https://codecov.io/gh/firelink-data/padder) +[![CI](https://github.com/firelink-data/padder/actions/workflows/ci.yml/badge.svg)](https://github.com/firelink-data/padder/actions/workflows/ci.yml) +[![Tests](https://github.com/firelink-data/padder/actions/workflows/tests.yml/badge.svg)](https://github.com/firelink-data/padder/actions/workflows/tests.yml) + +*String formatting and padding, done right, the rusty way.* + + +
+ +## 🔎 Overview + +... + +## 📦 Installation + +The easiest way to include *padder* in your projects is by using the [Cargo](https://crates.io/) package manager. +``` +$ cargo add padder +``` + +Alternatively, you can build from source by cloning this repo and compiling using Cargo and then linking the library to your project. +``` +$ git clone https://github.com/firelink-data/padder.git +$ cd pader +$ cargo build --release +``` + +## 📋 License +All code is to be held under a general MIT license, please see [LICENSE](https://github.com/firelink-data/padder/blob/main/LICENSE) for specific information.