open-index/open-npm huggingface dataset:
npm package: @floorsfi/core
Description: Core code shared between Floors Finance apps and pkgs
Latest version: 0.0.1

<div align="center">

[![npm latest package][npm-latest-image]][npm-url]
[![Build Status][ci-image]][ci-url]
[![License][license-image]][license-url]
[![npm downloads][npm-downloads-image]][npm-url]
[![Follow on Twitter][twitter-image]][twitter-url]

</div>

## 0xMEMO NPM package Template

Bun + Npm + Typescript + Standard Version + Flat Config Linting + Husky + Commit / Release Pipeline

## Summary

This package contains < a template for devoloping for npm packages > for [FloorsFinance](https://github.com/InverterNetwork).

Check out the [Changelog](./CHANGELOG.md) to see what changed in the last releases.

## Install

```bash
bun add @floorsfi/core
```

Install Bun ( bun is the default package manager for this project ( its optional ) ):

```bash
# Supported on macOS, Linux, and WSL
curl -fsSL https://bun.sh/install | bash
# Upgrade Bun every once in a while
bun upgrage
```

## Developing

Install Dependencies:

```bash
bun i
```

Watching TS Problems:

```bash
bun watch
```

Format / Lint / Type Check:

```bash
bun format
bun lint
bun type-check
```

## How to make a release

**For the Maintainer**: Add `NPM_TOKEN` to the GitHub Secrets.

1. PR with changes
2. Merge PR into main
3. Checkout main
4. `git pull`
5. `bun release: '' | alpha | beta` optionally add `-- --release-as minor | major | 0.0.1`
6. Make sure everything looks good (e.g. in CHANGELOG.md)
7. Lastly run `bun release:pub`
8. Done

## License

This package is licensed - see the [LICENSE](./LICENSE.md) file for details.

[ci-image]: https://badgen.net/github/checks/InverterNetwork/floors-core/main?label=ci
[ci-url]: https://github.com/InverterNetwork/floors-core/actions/workflows/ci.yaml
[npm-url]: https://npmjs.org/package/@floorsfi/core
[twitter-url]: https://twitter.com/FloorsFinance
[twitter-image]: https://img.shields.io/twitter/follow/FloorsFinance.svg?label=follow+FloorsFinance
[license-image]: https://img.shields.io/badge/License-Apache%20v2-blue
[license-url]: ./LICENSE.md
[npm-latest-image]: https://img.shields.io/npm/v/@floorsfi/core/latest.svg
[npm-downloads-image]: https://img.shields.io/npm/dm/@floorsfi/core.svg