[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/srht 235929a7a6 21/27: Update README.
From: |
ELPA Syncer |
Subject: |
[elpa] externals/srht 235929a7a6 21/27: Update README. |
Date: |
Tue, 17 May 2022 22:58:00 -0400 (EDT) |
branch: externals/srht
commit 235929a7a6d85be52b65f281f836824ccded130d
Author: Aleksandr Vityazev <avityazev@posteo.org>
Commit: Aleksandr Vityazev <avityazev@posteo.org>
Update README.
---
README.md | 16 ++++++++++++++++
README.org | 19 +++++++++++++++++++
2 files changed, 35 insertions(+)
diff --git a/README.md b/README.md
index f75466b07e..03e65c3dc7 100644
--- a/README.md
+++ b/README.md
@@ -6,3 +6,19 @@
# About
GNU Emacs [sourcehut](https://sr.ht) API client.
+
+
+# Setup
+
+To use this client, you need to
[generate](https://meta.sr.ht/oauth/personal-token) a personal access token.
This token
+will have unrestricted access to all sr.ht APIs and can be used like a normal
+access token to authenticate API requests.
+
+After creating the token:
+
+ (setq srht-token TOKEN)
+
+It is also possible to store the token using auth-source.el, the host must be
+set to paste.sr.ht.
+
+ machine paste.sr.ht password TOKEN
diff --git a/README.org b/README.org
index c5585fda0c..3a090c3c9c 100644
--- a/README.org
+++ b/README.org
@@ -3,3 +3,22 @@
* About
GNU Emacs [[https://sr.ht][sourcehut]] API client.
+
+* Setup
+
+To use this client, you need to
[[https://meta.sr.ht/oauth/personal-token][generate]] a personal access token.
This token
+will have unrestricted access to all sr.ht APIs and can be used like a normal
+access token to authenticate API requests.
+
+After creating the token:
+
+#+begin_src elisp :lexical t
+(setq srht-token TOKEN)
+#+end_src
+
+It is also possible to store the token using `auth-source.el', the host must be
+set to paste.sr.ht.
+
+#+begin_example
+machine paste.sr.ht password TOKEN
+#+end_example
- [elpa] branch externals/srht created (now 0e53961bbc), ELPA Syncer, 2022/05/17
- [elpa] externals/srht f88188bdcb 02/27: Add license., ELPA Syncer, 2022/05/17
- [elpa] externals/srht 0e2038516e 01/27: Initial commit., ELPA Syncer, 2022/05/17
- [elpa] externals/srht cf96533faf 03/27: Add guix.scm., ELPA Syncer, 2022/05/17
- [elpa] externals/srht 65e791cce0 05/27: Move Elisp files to the lisp dir., ELPA Syncer, 2022/05/17
- [elpa] externals/srht b1bdf349ab 07/27: Add build.yml and external dependencies., ELPA Syncer, 2022/05/17
- [elpa] externals/srht 41b2163b39 08/27: Replace emacs with emacs-next., ELPA Syncer, 2022/05/17
- [elpa] externals/srht 0db1310218 09/27: Downgrade Emacs requirements to 27.1., ELPA Syncer, 2022/05/17
- [elpa] externals/srht 235929a7a6 21/27: Update README.,
ELPA Syncer <=
- [elpa] externals/srht e17edd7643 04/27: Add README., ELPA Syncer, 2022/05/17
- [elpa] externals/srht 6037d9f03c 22/27: Update README., ELPA Syncer, 2022/05/17
- [elpa] externals/srht 3c4df2cff1 06/27: Add make rules., ELPA Syncer, 2022/05/17
- [elpa] externals/srht 7b3792ac75 12/27: Eldev: use the path from the store for plz., ELPA Syncer, 2022/05/17
- [elpa] externals/srht 81519fed59 15/27: Add git service bindings., ELPA Syncer, 2022/05/17
- [elpa] externals/srht a99a8e4bd1 19/27: srht-git--repo-name-read: Add doc string., ELPA Syncer, 2022/05/17
- [elpa] externals/srht 9dd0d15e4a 20/27: srht-git-repo-update: Fix., ELPA Syncer, 2022/05/17
- [elpa] externals/srht 0e53961bbc 27/27: srht-read-with-annotaion: Add category arg., ELPA Syncer, 2022/05/17
- [elpa] externals/srht 0b37b7225f 24/27: Add support for pagination., ELPA Syncer, 2022/05/17
- [elpa] externals/srht f3cd7c5639 10/27: Set eldev-project-main-file., ELPA Syncer, 2022/05/17