Skip to content

Commit

Permalink
Refresh READMEs (#27)
Browse files Browse the repository at this point in the history
* Refresh READMEs

* Make logos friendly to both light/dark mode

* bump

* Fix

* lower case V for v4

* nit
  • Loading branch information
jiajames authored Sep 11, 2023
1 parent 7dd1f9a commit 2eae4dc
Show file tree
Hide file tree
Showing 6 changed files with 54 additions and 18 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<p align="center"><img src="https://dydx.exchange/icon.svg?" width="256" /></p>

<h1 align="center">v4 Clients</h1>

<div align="center">
<a href='https://www.npmjs.com/package/@dydxprotocol/v4-client-js'>
<img src='https://img.shields.io/npm/v/@dydxprotocol/v4-client-js.svg' alt='PyPI'/>
</a>
<a href='https://pypi.org/project/v4-client-py'>
<img src='https://img.shields.io/pypi/v/v4-client-py.svg' alt='PyPI'/>
</a>
<a href='https://github.com/dydxprotocol/v4-clients/blob/main/LICENSE'>
<img src='https://img.shields.io/badge/License-BSL_1.1-blue' alt='License' />
</a>
</div>

## v4-client-js
The v4-Client Typescript client is used for placing transactions and querying the dYdX chain.

## v4-client-py
Python client for dYdX (v4 API).

The library is currently tested against Python versions 3.9, and 3.11.
15 changes: 13 additions & 2 deletions v4-client-js/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
# V4 Client
<p align="center"><img src="https://dydx.exchange/icon.svg?" width="256" /></p>

The V4-Client Typescript client is used for placing transactions and querying the dYdX chain.
<h1 align="center">v4 Client for Javascript</h1>

<div align="center">
<a href='https://www.npmjs.com/package/@dydxprotocol/v4-client-js'>
<img src='https://img.shields.io/npm/v/@dydxprotocol/v4-client-js.svg' alt='NPM'/>
</a>
<a href='https://github.com/dydxprotocol/v4-clients/blob/main/v4-client-js/LICENSE'>
<img src='https://img.shields.io/badge/License-BSL_1.1-blue' alt='License' />
</a>
</div>

The v4-Client Typescript client is used for placing transactions and querying the dYdX chain.

## Development

Expand Down
4 changes: 2 additions & 2 deletions v4-client-js/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion v4-client-js/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@dydxprotocol/v4-client-js",
"version": "0.33.1",
"version": "0.33.2",
"description": "General client library for the new dYdX system (v4 decentralized)",
"main": "build/src/index.js",
"scripts": {
Expand Down
26 changes: 14 additions & 12 deletions v4-client-py/README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,26 @@
<p align="center"><img src="https://dydx.exchange/flat.svg" width="256" /></p>
<p align="center"><img src="https://dydx.exchange/icon.svg?" width="256" /></p>

<h1 align="center">v4 Client for Python</h1>

<div align="center">
<a href='https://pypi.org/project/dydx-v4-python'>
<img src='https://img.shields.io/pypi/v/dydx-v4-python.svg' alt='PyPI'/>
<a href='https://pypi.org/project/v4-client-py'>
<img src='https://img.shields.io/pypi/v/v4-client-py.svg' alt='PyPI'/>
</a>
<a href='https://github.com/dydxprotocol/dydx-v4-python/blob/master/LICENSE'>
<img src='https://img.shields.io/github/license/dydxprotocol/dydx-v4-python.svg' alt='License' />
<a href='https://github.com/dydxprotocol/v4-clients/blob/main/v4-client-py/LICENSE'>
<img src='https://img.shields.io/badge/License-BSL_1.1-blue' alt='License' />
</a>
</div>
<br>

Python client for dYdX (v4 API).

The library is currently tested against Python versions 3.9, and 3.11.

## Installation (TODO: modify after release)
## Installation

The `dydx-v4-python` package is available on [PyPI](https://pypi.org/project/dydx-v4-python). Install with `pip`:
The `v4-client-py` package is available on [PyPI](https://pypi.org/project/v4-client-py). Install with `pip`:

```bash
pip install dydx-v4-python
pip install v4-client-py
```

## Getting Started
Expand All @@ -29,16 +30,17 @@ Sample code is located in examples folder
## Development Setup - VS Code

Install Microsoft Python extensions
```
Shift-Command-P: Create Python Environment
Select Venv
Select Python 3.9 as interpreter
Select requirements.txt as the dependencies to install
```

TODO: Add v4-proto to the requirements.txt

Install v4-proto
Install requirements
```
pip install -i https://test.pypi.org/simple/ v4-proto==<version>
pip install -r requirements.txt
```

VS Code will automatically switch to .venv environment when running example code. Or you can manually switch
Expand Down
2 changes: 1 addition & 1 deletion v4-client-py/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ package-dir = {"" = "v4_client_py"}

[tool.poetry]
name = "v4-client-py"
version = "0.4.0"
version = "0.4.1"
description = "dYdX v4 Client"
authors = ["John Huang <contact@dydx.exchange>"]
license = "BSL-1.1"
Expand Down

0 comments on commit 2eae4dc

Please sign in to comment.