types/README.md

25 lines
962 B
Markdown

# 📦 HyperTuner common TypeScript types
![master](https://github.com/hyper-tuner/types/actions/workflows/lint.js.yml/badge.svg?branch=master)
[![Maintainability](https://api.codeclimate.com/v1/badges/bb3cdf2c77ec769ee401/maintainability)](https://codeclimate.com/github/hyper-tuner/types/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/bb3cdf2c77ec769ee401/test_coverage)](https://codeclimate.com/github/hyper-tuner/types/test_coverage)
![License](https://img.shields.io/github/license/hyper-tuner/types)
## Installation
Make sure you have registry specified in the `.npmrc` file:
```bash
@hyper-tuner:registry=https://npm.pkg.github.com
```
Authenticate to GitHub Packages:
[authenticating-to-github-packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-to-github-packages)
Proceed with the installation:
```bash
npm i --save @hyper-tuner/types
```