Skip to content

Commit

Permalink
doc: update api documentation, add PORT env variable
Browse files Browse the repository at this point in the history
  • Loading branch information
amycatgirl committed Oct 21, 2024
1 parent 28260b9 commit a857edd
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ or
DOMAIN="https://example.com" deno task start
```

If you want to use a custom port, edit the `PORT` environment variable

```bash
PORT="3000" deno task start
```

### docker/podman

an image for docker/podman containers is available at `ghcr.io/amycatgirl/tempstore:latest`
Expand All @@ -34,7 +40,7 @@ use id with the `/object/:id` route (replace `:id` with your id)

### create a new object/file

route: `/create`
route: `/api/object`

method: `POST`

Expand All @@ -47,7 +53,7 @@ body

### get object/file

route `/objects/:id`
route `/api/object/:id`

method: `GET`

Expand Down

0 comments on commit a857edd

Please sign in to comment.