ini/README.md

27 lines
1.3 KiB
Markdown
Raw Normal View History

2021-09-26 09:28:35 -07:00
# 📦 SpeedyTuner INI parser
2021-11-27 02:25:07 -08:00
![Lint and test](https://github.com/speedy-tuner/ini/actions/workflows/test.js.yml/badge.svg?branch=master)
[![CodeQL](https://github.com/speedy-tuner/ini/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/speedy-tuner/ini/actions/workflows/codeql-analysis.yml)
2021-09-26 09:36:28 -07:00
[![Maintainability](https://api.codeclimate.com/v1/badges/6037e4d75ed48df20016/maintainability)](https://codeclimate.com/github/speedy-tuner/ini/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/6037e4d75ed48df20016/test_coverage)](https://codeclimate.com/github/speedy-tuner/ini/test_coverage)
2021-09-26 09:28:35 -07:00
![License](https://img.shields.io/github/license/speedy-tuner/ini)
2021-11-27 02:30:51 -08:00
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fspeedy-tuner%2Fini.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fspeedy-tuner%2Fini?ref=badge_shield)
2021-09-26 09:28:35 -07:00
## Installation
Make sure you have registry specified in the `.npmrc` file:
```bash
@speedy-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 @speedy-tuner/ini
```