@btc-vision/bsi-common/README.md

Common library for OP_NET.

# OP_NET - Common Library

![Bitcoin](https://img.shields.io/badge/Bitcoin-000?style=for-the-badge&logo=bitcoin&logoColor=white)
![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
![NodeJS](https://img.shields.io/badge/Node%20js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white)
![NPM](https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white)
![Gulp](https://img.shields.io/badge/GULP-%23CF4647.svg?style=for-the-badge&logo=gulp&logoColor=white)
![ESLint](https://img.shields.io/badge/ESLint-4B3263?style=for-the-badge&logo=eslint&logoColor=white)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

## Introduction
This library includes all the shared methods that OP_NET uses in its projects. It is written in TypeScript and provides a comprehensive set of functions.

## Getting Started
Getting started with the OP_NET Common Library is easy. Follow the steps below to install the library and start using it in your project.

### Prerequisites

- Node.js version 16.x or higher
- npm (Node Package Manager)

### Installation

```shell
npm i @btc-vision/bsi-common
```

#### Development

1. Clone the repository:
   ```bash
   git clone https://github.com/btc-vision/bsi-common.git
   ```
2. Navigate to the repository directory:
   ```bash
   cd bsi-common
   ```
3. Install the required dependencies:
   ```bash
   npm i
   ```

## Contribution

Contributions are welcome! Please read through the `CONTRIBUTING.md` file for guidelines on how to submit issues, feature requests, and pull requests. We appreciate your input and encourage you to help us improve OP_NET.

## License

This project is open source and available under the [MIT License](LICENSE). If you have any suggestions or contributions, please feel free to submit a pull request.