aboutsummaryrefslogtreecommitdiffstats
path: root/git.sr.ht
diff options
context:
space:
mode:
authorнаб <nabijaczleweli@nabijaczleweli.xyz>2020-08-27 16:35:37 +0200
committerDrew DeVault <sir@cmpwn.com>2020-08-28 09:02:27 -0400
commita2f27ee7c1299af5e59431baed74b097b854c040 (patch)
treee8f63201e01623bbffe7018ca2e656a45963728d /git.sr.ht
parent6ea6e6451243e7cc62727d88bccf2b461d153f0f (diff)
downloadsr.ht-docs-a2f27ee7c1299af5e59431baed74b097b854c040.tar.gz
Spec curl --data-binary to not mangle the uploaded README and link to example repo
curl mangles the upload (stripping newlines, probably something else) with just --data
Diffstat (limited to 'git.sr.ht')
-rw-r--r--git.sr.ht/index.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/git.sr.ht/index.md b/git.sr.ht/index.md
index 48a28ac..9792ef5 100644
--- a/git.sr.ht/index.md
+++ b/git.sr.ht/index.md
@@ -93,7 +93,7 @@ you will be able to run:
curl -H "Authorization: Bearer your-token" \
-H "Content-Type: text/html" \
-XPUT \
- --data @README.html \
+ --data-binary @README.html \
"https://git.sr.ht/api/repos/your-fun-repo/readme"
```
@@ -105,4 +105,6 @@ It may be desirable to configure a builds.sr.ht job to compile your README from
another markup format and submit it on each git push; if so, you will need to
review the [build secrets
tutorial](https://man.sr.ht/tutorials/builds.sr.ht/using-build-secrets.md) to
-safely store your OAuth token.
+safely store your OAuth token. Check out the
+[example](https://git.sr.ht/~nabijaczleweli/html-readme) to avoid some common
+pitfalls.