Skip to content

Commit 900be25

Browse files
committed
Add readme
1 parent 624ac64 commit 900be25

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

cmd/patchbay-cli/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
This is a CLI companion tool for the patchbay.pub web service.
2+
3+
It is still very early in development. See main.go for all functionality and
4+
uses.
5+
6+
To host a static site, run something like the following from the root directory
7+
of the site:
8+
9+
```
10+
patchbay-cli host -root-channel https://patchbay.pub/my-secret-channel
11+
```
12+
13+
You can then navigate to `https://patchbay.pub/my-secret-channel/` in your
14+
browser. Don't forget the trailing slash, or use the full /index.html URL.
15+
This is necessary for relative URLs to work properly in browsers.

0 commit comments

Comments
 (0)