Skip to content

Commit

Permalink
docs: screenshot and logo (#274)
Browse files Browse the repository at this point in the history
Signed-off-by: Chris Gianelloni <[email protected]>
  • Loading branch information
wolf31o2 authored Nov 20, 2024
1 parent 26260ab commit 4541710
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 1 deletion.
Binary file added .github/assets/tx-submit-api-20241120.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/tx-submit-api-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# tx-submit-api

Cardano Transaction Submission API
<div align="center">
<img src="./.github/assets/tx-submit-api-logo.png" alt="Tx Submit API" width="640">
</div>

Transaction Submission API for Cardano

A simple HTTP API which accepts a CBOR encoded Cardano transaction as a
payload body and submits it to a Cardano full node using the Ouroboros
Expand Down Expand Up @@ -135,6 +139,17 @@ curl -X POST \
http://localhost:8090/api/submit/tx
```

### Metrics UI

There is a metrics web user interface running on the service's API port.

Connect to [http://localhost:8090/ui/](http://localhost:8090/ui/) with your
browser to view it.

<div align="center">
<img src="./.github/assets/tx-submit-api-20241120.png" alt="Tx Submit API" width="640">
</div>

## Development

There is a Makefile to provide some simple helpers.
Expand Down

0 comments on commit 4541710

Please sign in to comment.