Skip to content

Commit

Permalink
docs: Update code block syntax and add important notice in README
Browse files Browse the repository at this point in the history
- Change code block from `#+begin_src` to `#+begin_example` for
  auth-sources entry in README.org.
- Add an important notice block highlighting the insecurity of storing
  OAuth tokens in plain text and the need to set proper file
  permissions.
- Remove redundant plain text note about OAuth token security, as it
  has been replaced with the important notice block.
- Fix minor whitespace issue in the Usage section.
  • Loading branch information
KarimAziev committed Dec 17, 2023
1 parent 7a72a4e commit a595583
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -188,9 +188,9 @@ To employ this method, set =igist-auth-marker= to the symbol =igist=:

Next, add an entry to your =auth-sources=:

#+begin_src plaintext
#+begin_example
machine api.github.com login YOUR-GITHUB-USERNAME^igist password YOUR-GITHUB-TOKEN
#+end_src
#+end_example

You can add this entry to your =~/.authinfo.gpg= file (recommended for secure, encrypted storage) or =~/.authinfo= (see variable =auth-sources=).

Expand Down Expand Up @@ -224,9 +224,13 @@ Example with =use-package=.
igist-auth-marker)))
(error (message "Igist-current-user-name cannot setted")))))
#+end_src
#+begin_quote
[!IMPORTANT]

In this method, your OAuth token will be stored as plain text in your emacs config file, which is insecure. Ensure your config file permissions are appropriately set to prevent unauthorized access.
#+end_quote


*Note*: In this method, your OAuth token will be stored as plain text in your emacs config file, which is insecure. Ensure your config file permissions are appropriately set to prevent unauthorized access.


** Usage
Expand All @@ -243,7 +247,7 @@ There are two ways in which gists can be presented - as a table or as minibuffer
*** Table

- ~M-x igist-list-gists~ - to display gists of logged GitHub user.

- ~M-x igist-explore-public-gists~ - list public gists sorted by most recently updated to least recently updated.
[[./igist-explore-demo.png][./igist-explore-demo.png]]

Expand Down

0 comments on commit a595583

Please sign in to comment.