types/README.md

25 lines
969 B
Markdown
Raw Normal View History

2021-09-26 05:21:51 -07:00
# 📦 SpeedyTuner common TypeScript types
2021-09-26 09:12:27 -07:00
![master](https://github.com/speedy-tuner/types/actions/workflows/lint.js.yml/badge.svg?branch=master)
2021-09-26 07:59:19 -07:00
[![Maintainability](https://api.codeclimate.com/v1/badges/bb3cdf2c77ec769ee401/maintainability)](https://codeclimate.com/github/speedy-tuner/types/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/bb3cdf2c77ec769ee401/test_coverage)](https://codeclimate.com/github/speedy-tuner/types/test_coverage)
![License](https://img.shields.io/github/license/speedy-tuner/types)
2021-09-26 05:21:51 -07:00
## Installation
Make sure you have registry specified in the `.npmrc` file:
```bash
@speedy-tuner:registry=https://npm.pkg.github.com
```
2021-09-26 06:59:47 -07:00
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)
2021-09-26 05:21:51 -07:00
Proceed with the installation:
```bash
npm i --save @speedy-tuner/types
```