From ed098bf38cf46c8348e184d910f7d0768cedb05f Mon Sep 17 00:00:00 2001
From: Sliim <sliim@mailoo.org>
Date: Thu, 25 Apr 2019 13:11:06 +0200
Subject: [PATCH] Add known issues section in readme

with wrong-type-argument integer-or-marker-p nil error due to TLS
version on Github API, reported in #26
---
 README.org | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/README.org b/README.org
index d299592..6d27331 100644
--- a/README.org
+++ b/README.org
@@ -77,3 +77,23 @@ Move into repository's root directory and run:
 cask install
 cask exec ert-runner
 #+END_SRC
+** Known issues
+*** wrong-type-argument integer-or-marker-p nil
+Reported in https://github.com/Sliim/helm-github-stars/issues/26
+
+Github API use TLS 1.3 which don't like emacs's default TLS settings.
+
+I suggest to set these settings in your emacs configuration:
+```
+(setq gnutls-verify-error t
+      gnutls-min-prime-bits 2048
+      gnutls-algorithm-priority "SECURE192:+SECURE128:-VERS-ALL:+VERS-TLS1.2"
+      nsm-settings-file (expand-file-name "network-security.data" user-emacs-directory)
+      nsm-save-host-names t
+      network-security-level 'high
+      tls-checktrust t
+      tls-program '("gnutls-cli -p %p --dh-bits=2048 --ocsp --x509cafile=%t --priority='SECURE192:+SECURE128:-VERS-ALL:+VERS-TLS1.2:%%PROFILE_MEDIUM' %h"))
+```
+Sources:
+- https://github.com/Sliim/emacs.d/blob/master/modules/emacsd-tls-hardening-module.el
+- https://www.reddit.com/r/emacs/comments/8sykl1/emacs_tls_defaults_are_downright_dangerous/