koobor-token/README.md

Koobor ERC20 Token Smart Contracts

[![Actions Status](https://github.com/abdelhamidbakhta/koobor-token/workflows/main/badge.svg)](https://github.com/abdelhamidbakhta/koobor-token/actions)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![npm version](https://badge.fury.io/js/koobor-token.svg)](https://badge.fury.io/js/koobor-token)

# Koobor Token

## Overview

Koobor ERC20 token.

### 📦 Installation

```console
$ yarn
```

### ⛏️ Compile

```console
$ yarn compile
```

This task will compile all smart contracts in the `contracts` directory.
ABI files will be automatically exported in `build/abi` directory.

### 📚 Documentation

Documentation is auto-generated after each build in `docs` directory.

The generated output is a static website containing smart contract documentation.

### 🌡️ Testing

```console
$ yarn test
```

### 📊 Code coverage

```console
$ yarn coverage
```

The report will be printed in the console and a static website containing full report will be generated in `coverage` directory.

### ✨ Code style

```console
$ yarn prettier
```

## 📄 License

**Koobor Token** is released under the [Apache-2.0](LICENSE).