-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Michael Pautov
committed
Oct 25, 2021
1 parent
fb72157
commit 2fd464a
Showing
4 changed files
with
566 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,37 @@ | ||
# lifinance/types | ||
# Li.Finance - Types | ||
Types for lifi projects | ||
|
||
### Install dependencies | ||
|
||
Install dependencies with npm: | ||
|
||
```bash | ||
npm i | ||
``` | ||
|
||
### Test | ||
|
||
Test your code with Jest framework: | ||
|
||
```bash | ||
npm run test | ||
``` | ||
|
||
**Note:** Example TypeScript Package uses [husky](https://typicode.github.io/husky/), [pinst](https://github.com/typicode/pinst) and [commitlint](https://commitlint.js.org/) to automatically execute test and [lint commit message](https://www.conventionalcommits.org/) before every commit. | ||
|
||
### Build | ||
|
||
Build production (distribution) files in your **dist** folder: | ||
|
||
```bash | ||
npm run build | ||
``` | ||
|
||
|
||
### Publish | ||
In order to update the package, you need to add a tag for this. | ||
|
||
Example: | ||
``` | ||
git push origin v0.0.1 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
### Installation | ||
|
||
``` | ||
npm install --save @lifinance/types | ||
``` | ||
|
||
### Summary | ||
|
||
This package contains type definitions for lifinance projects (https://github.com/lifinance). |
Oops, something went wrong.