fix(order_utils.py): tweaks for first publish (#1185)
This commit is contained in:
45
python-packages/order_utils/README.md
Normal file
45
python-packages/order_utils/README.md
Normal file
@@ -0,0 +1,45 @@
|
||||
## 0x-order-utils
|
||||
|
||||
0x order-related utilities for those developing on top of 0x protocol.
|
||||
|
||||
Read the [documentation](https://0x.readthedocs.io/projects/order-utils/en/latest/)
|
||||
|
||||
## Installing
|
||||
|
||||
```bash
|
||||
pip install 0x-order-utils
|
||||
```
|
||||
|
||||
## 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 Code and Dependencies
|
||||
|
||||
Ensure that you have Python >=3.6 installed, then:
|
||||
|
||||
```bash
|
||||
pip install -e .[dev]
|
||||
```
|
||||
|
||||
### Test
|
||||
|
||||
`./setup.py test`
|
||||
|
||||
### Clean
|
||||
|
||||
`./setup.py clean --all`
|
||||
|
||||
### Lint
|
||||
|
||||
`./setup.py lint`
|
||||
|
||||
### Build Documentation
|
||||
|
||||
`./setup.py build_sphinx`
|
||||
|
||||
### More
|
||||
|
||||
See `./setup.py --help-commands` for more info.
|
Reference in New Issue
Block a user