aboutsummaryrefslogblamecommitdiffstats
path: root/packages/connect/README.md
blob: 386b7bbbf802e24e8d9f36a07df0d743c11358f2 (plain) (tree)
1
2
3
4
5
6
7
8
9
10
              
 
                                                                                                                                                                                        



               
                    

   

                                                                                                               

                    
                                                                                      
 

   

        

                                                   


               
                                                                                                                                          
 
                                                                                        
 
                        
 
                                                                      
 




                                            
 





            
                                                                                                                             

       
                          




                                  
                          







          










             
## @0x/connect

This repository contains a Javascript library that makes it easy to interact with Relayers that conform to the [Standard Relayer API](https://github.com/0xProject/standard-relayer-api)

## Installation

```bash
yarn add @0x/connect
```

If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:

```json
"compilerOptions": {
    "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}
```

## Usage

-   [Docs](https://0xproject.com/docs/connect)
-   [Tutorials](https://0xproject.com/wiki#connect)

## Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.

### Install dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

```bash
yarn config set workspaces-experimental true
```

Then install dependencies

```bash
yarn install
```

### Build

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

```bash
PKG=@0x/connect yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0x/connect yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```