ini/README.md

26 lines
1.1 KiB
Markdown
Raw Normal View History

2022-06-30 15:44:57 -07:00
# 📦 HyperTuner INI parser
2021-09-26 09:28:35 -07:00
2022-06-30 15:44:57 -07:00
![Lint and test](https://github.com/hyper-tuner/ini/actions/workflows/test.js.yml/badge.svg?branch=master)
[![CodeQL](https://github.com/hyper-tuner/ini/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/hyper-tuner/ini/actions/workflows/codeql-analysis.yml)
[![Maintainability](https://api.codeclimate.com/v1/badges/6037e4d75ed48df20016/maintainability)](https://codeclimate.com/github/hyper-tuner/ini/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/6037e4d75ed48df20016/test_coverage)](https://codeclimate.com/github/hyper-tuner/ini/test_coverage)
![License](https://img.shields.io/github/license/hyper-tuner/ini)
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
2022-06-30 15:44:57 -07:00
npm i --save @hyper-tuner/ini
2021-09-26 09:28:35 -07:00
```