Skip to content

Commit 45b07e4

Browse files
committed
docs: mention new GH-Pages deployment in README
Before merging #255, the gh-pages branch of this repository was used for our live API reference instance. Unfortunately, that branch houses multiple binaries which were rebuilt on every-push, leading to the branch growing in-size without bound, and dramatically increasing the storage and network burden for all clones and forks. Following #255 and the deletion of the gh-pages branch, the repo can be cloned almost instantly, and the burden is fully offloaded to a second repository which no one should need to clone under normal circumstances. This commit simply adds reference to the new deployment (since GH's web interface is not smart enough to link to the external repo automatically). Signed-off-by: Sam Stuewe <[email protected]>
1 parent 8aefd51 commit 45b07e4

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,9 @@ Note that if you have not already installed the xcode cli tools you will need to
100100
```
101101
# Run the Code
102102

103+
The API Reference is now housed in [an external repository](https://github.com/mit-dci/opencbdc-tx-pages/).
104+
See the [live deployment](https://mit-dci.github.io/opencbdc-tx-pages/) to browse.
105+
103106
## UHS-based Architectures (2PC & Atomizer)
104107
See the [2PC & Atomizer User Guide](docs/2pc_atomizer_user_guide.md)
105108
## PArSEC Architecture

0 commit comments

Comments
 (0)