[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/srht 4bffcc1781: Update README.
|
From: |
ELPA Syncer |
|
Subject: |
[elpa] externals/srht 4bffcc1781: Update README. |
|
Date: |
Sun, 12 Nov 2023 09:58:46 -0500 (EST) |
branch: externals/srht
commit 4bffcc1781c3ed54c0b42410872b26fdeb1a1ed3
Author: Aleksandr Vityazev <avityazev@posteo.org>
Commit: Aleksandr Vityazev <avityazev@posteo.org>
Update README.
---
README.md | 27 ++++++++++++++++++++++-----
README.org | 23 ++++++++++++++++-------
2 files changed, 38 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index 9b95358359..1ba785076f 100644
--- a/README.md
+++ b/README.md
@@ -35,19 +35,35 @@ installing it, place files from /lisp folder in `load-path`.
# Setup
-To use this client, you need to
[generate](https://meta.sr.ht/oauth/personal-token) a personal access token
(Oauth not
-Oauth2). This token will have unrestricted access to all sr.ht APIs and can be
-used like a normal access token to authenticate API requests.
+To use this client, you need to generate a personal access tokens
([Oauth](https://meta.sr.ht/oauth/personal-token) and
+[Oauth2](https://meta.sr.ht/oauth2)). Oauth token will have unrestricted
access to all sr.ht APIs and can be
+used like a normal access token to authenticate legacy API requests.
-After creating the token:
+After creating the tokens:
- (setq srht-token TOKEN)
+
+## oauth token
+
+ (setq srht-token OAUTH-TOKEN)
It is also possible to store the token using `auth-source.el`, the host must be
set to sr.ht.
machine sr.ht password TOKEN
+
+## oauth2 token
+
+To store the token use `auth-source.el`, the host must be set to git.sr.ht.
+
+ machine git.sr.ht password TOKEN
+
+Strongly encouraged for the user to limit the scope of access that is provided
+by an authentication token.
+
+
+## rest
+
You also need to set srht-username:
(setq srht-username USERNAME)
@@ -125,3 +141,4 @@ so may contact
[emacs-devel@gnu.org](mailto:emacs-devel@gnu.org) to request the
# License
GPLv3
+
diff --git a/README.org b/README.org
index 653dad33d0..761d5222b6 100644
--- a/README.org
+++ b/README.org
@@ -29,14 +29,14 @@ guix package -f guix.scm
installing it, place files from /lisp folder in =load-path=.
* Setup
-To use this client, you need to
[[https://meta.sr.ht/oauth/personal-token][generate]] a personal access token
(Oauth not
-Oauth2). 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:
+To use this client, you need to generate a personal access tokens
([[https://meta.sr.ht/oauth/personal-token][Oauth]] and
+[[https://meta.sr.ht/oauth2][Oauth2]]). Oauth token will have unrestricted
access to all sr.ht APIs and can be
+used like a normal access token to authenticate legacy API requests.
+After creating the tokens:
+** oauth token
#+begin_src elisp :lexical t
-(setq srht-token TOKEN)
+(setq srht-token OAUTH-TOKEN)
#+end_src
It is also possible to store the token using =auth-source.el=, the host must be
@@ -46,8 +46,17 @@ set to sr.ht.
machine sr.ht password TOKEN
#+end_example
-You also need to set srht-username:
+** oauth2 token
+To store the token use =auth-source.el=, the host must be set to git.sr.ht.
+
+#+begin_example
+machine git.sr.ht password TOKEN
+#+end_example
+Strongly encouraged for the user to limit the scope of access that is provided
+by an authentication token.
+** rest
+You also need to set srht-username:
#+begin_src elisp :lexical t
(setq srht-username USERNAME)
#+end_src
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [elpa] externals/srht 4bffcc1781: Update README.,
ELPA Syncer <=