Project title

Briefly describe what your project does.

Table of Contents

1. Features
   • Out of scope
2. Getting started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License

Features

• List project features here

Out of scope

Optional section. Briefly clarify anything that could be considered to be in scope but are not. If this section is removed, please also be sure to remove it from the table of contents.

Getting Started

Simple and easy instructions on setting up your project locally.

Prerequisites

List software prerequisites here in the format of the example below.

• docker

  brew install docker

Installation

List installation steps in the format of the example below.

1. Clone the repo

   git clone https://github.com/icon-project/REPO-NAME.git

2. Install project dependencies

   yarn install

Usage

Examples of how the project is intended to be used.

For more examples, please refer to the documentation.

Contributing

If you want to contribute, be sure to review the contributing guidelines.

We use GitHub Issues for tracking requests and bugs, and Github Discussions for general questions and discussion.

The project strives to abide by generally accepted best practices in open-source software development.

License

Distributed under the PROJECT-LICENSE License. See LICENSE for more information.