branch: externals/srht commit 50ad7d35bced2ab984f15524c1855e3c94355a5a Author: Aleksandr Vityazev <avitya...@posteo.org> Commit: Aleksandr Vityazev <avitya...@posteo.org>
Update README. --- README.md | 10 +++++++++- README.org | 17 ++++++++++++++--- 2 files changed, 23 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e2e3ea8139..6e3bf4f9cc 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,17 @@ <a href="https://builds.sr.ht/~akagi/srht.el/commits/master/.build.yml"><img alt="Build" src="https://builds.sr.ht/~akagi/srht.el/commits/master/.build.yml.svg"/></a> -### Version 0.1.0 +### Version 0.1 # About GNU Emacs [sourcehut](https://sr.ht) API client. +`srht` provides bindings to the Sourcehut REST API as well as commands for +interacting with it. It currently supports two services: `git.sr.ht` — git +hosting and `paste.sr.ht` — ad-hoc text file hosting. + # Installation @@ -44,6 +48,10 @@ You also need to set srht-username: (setq srht-username USERNAME) +If you are using a self-hosted instanse: + + (setq srht-domain DOMAIN) + # Commands diff --git a/README.org b/README.org index 134f22edd1..ccacc6632b 100644 --- a/README.org +++ b/README.org @@ -1,11 +1,16 @@ #+OPTIONS: toc:nil #+html: <a href="https://builds.sr.ht/~akagi/srht.el/commits/master/.build.yml"><img alt="Build" src="https://builds.sr.ht/~akagi/srht.el/commits/master/.build.yml.svg"/></a> -*** Version 0.1.0 +*** Version 0.1 * About + GNU Emacs [[https://sr.ht][sourcehut]] API client. +=srht= provides bindings to the Sourcehut REST API as well as commands for +interacting with it. It currently supports two services: =git.sr.ht= — git +hosting and =paste.sr.ht= — ad-hoc text file hosting. + * Installation ** With Guix @@ -18,8 +23,8 @@ guix package -f guix.scm ** Manual -~srht~ depends on the HTTP library ~plz~ which is available in ELPA. After -installing it, place files from /lisp folder in ~load-path~. +=srht= depends on the HTTP library =plz= which is available in ELPA. After +installing it, place files from /lisp folder in =load-path=. * Setup @@ -46,6 +51,12 @@ You also need to set srht-username: (setq srht-username USERNAME) #+end_src +If you are using a self-hosted instanse: + +#+begin_src elisp :lexical t +(setq srht-domain DOMAIN) +#+end_src + * Commands | Function | Description |