Skip to content

Commit

Permalink
chore: reference license in package.json
Browse files Browse the repository at this point in the history
  • Loading branch information
t8 committed Aug 5, 2022
1 parent ccf8f89 commit bf2d682
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 17 deletions.
24 changes: 8 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,23 @@
<p align="center" id="title">
<a href="https://verto.exchange">
<img src="https://raw.githubusercontent.com/useverto/design/master/logo/logo_light.svg" alt="Verto logo (light version)" width="110" />
</a>
<img src="https://raw.githubusercontent.com/useverto/design/master/logo/logo_light.svg" alt="Verto logo (light version)" width="110" />

<h3 align="center">Verto Component</h3>
<h3 align="center">Verto Flex</h3>

<p align="center">
Build Verto functionality into your own SmartWeave contract
An embeddable, programmable order book framework
</p>
</p>

## Installation

```sh
npm install @verto/component
npm install @verto/flex
```

or

```sh
yarn add @verto/component
yarn add @verto/flex
```

## Prerequisites
Expand All @@ -39,30 +37,24 @@ Your SmartWeave contract state MUST contain the following variables in order for

## Usage

This library implements the core functions necessary to give SmartWeave contracts the ability to manage a central limit order book.
This framework includes the core functions necessary to give SmartWeave contracts the ability to embed and manage a central limit order book.

### Import

To use the library, you'll need to import its functions

```ts
import * as verto from "@verto/component";
```

OR

```ts
import {
AddPair,
CancelOrder,
CreateOrder,
Halt,
ReadOutbox,
} from "@verto/component";
} from "@verto/flex";
```

### Add a pair

```ts
const newState = await AddPair(state, action);
const { newState, result } = await AddPair(state, action);
```
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@verto/flex",
"description": "An embeddable, programmable order book framework",
"version": "0.1.0",
"version": "0.1.1",
"author": " ",
"repository": {
"type": "git",
Expand All @@ -11,6 +11,7 @@
"bugs": {
"url": "https://github.com/useverto/flex/issues"
},
"license": "https://github.com/useverto/flex/blob/main/LICENSE",
"files": [
"dist"
],
Expand Down

0 comments on commit bf2d682

Please sign in to comment.