Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] add install instructions and badges #4

Merged
merged 1 commit into from Dec 14, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
39 changes: 37 additions & 2 deletions README.md
@@ -1,2 +1,37 @@
# padder
String formatting done right.
<div align="center">
<br/>
<div align="left">
<br/>
</div>

[![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.*


</div>

## 🔎 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.