frogress/README.md

22 lines
564 B
Markdown

# Frogress
An API for storing/retrieving decompilation progress
## Development
For those interested in contributing to frogress's development, please see [CONTRIBUTING.md](CONTRIBUTING.md).
## Usage
The API will be hosted at https://progress.deco.mp. Usage guide coming soon.
TODO: add example curl commands as well as code snippets / CSV parser for existing format
## Docker
This project can be deployed locally using [Docker Compose](https://docs.docker.com/compose/).
```sh
docker-compose up --build
```
See [DOCKER.md](DOCKER.md) for more information.