Merge pull request rudolfochrist#2 from rudolfochrist/1-unable-to-setup

Update documentation

Author: rudolfochrist

README.md

@@ -0,0 +1,79 @@
+
+
+# NAME
+
+ql-https — HTTPS support for Quicklisp via curl
+
+
+# VERSION
+
+    0.5.0
+
+
+# SYNOPSIS
+
+    (asdf:load-system "ql-https")
+
+
+# DESCRIPTION
+
+
+## PREREQUISITES
+
+-   [Quicklisp](https://www.quicklisp.org/beta/)
+-   curl (refer to your system package manager)
+
+
+## INSTALLATION
+
+1.  `mkdir ~/quicklisp` and `cd ~/quicklisp`
+2.  Go to <https://beta.quicklisp.org/client/quicklisp.sexp> and lookup `:client-tar` URL, download it, verify
+    hash and untar.
+3.  Clone ql-https from <https://github.com/rudolfochrist/ql-https.git> to
+    to `~/common-lisp/ql-https`
+4.  Disconnect internet. (Prevent that anything leaks over HTTP during the installation)
+5.  Start a fresh REPL and (require 'asdf)
+6.  Load `~/common-lisp/ql-https/ql-setup.lisp`
+7.  Eval `(asdf:load-system "ql-https")`
+8.  Inspect `ql-http:*fetch-scheme-functions*` and verify everything was registered properly. Both `http` and
+    `https` have `ql-https:fetcher` registered.
+9.  Connect internet.
+10. Eval `(quicklisp:setup)` - use the USE-HTTPS restart if you hit the network.
+
+Removing the *Missing client-info.sexp, using mock info* warning.
+
+1.  Eval `(ql:update-client)`
+2.  move `~/quicklisp/tmp/client-info.sexp` to `~/quicklisp`
+
+Watch ASCIInema:
+
+[![asciicast](https://asciinema.org/a/585361.svg)](https://asciinema.org/a/585361)
+
+
+## STARTUP
+
+    (let ((quicklisp-init #p"~/common-lisp/ql-https/ql-setup.lisp"))
+      (when (probe-file quicklisp-init)
+        (load quicklisp-init)
+        (asdf:load-system "ql-https")
+        (uiop:symbol-call :quicklisp :setup)))
+    
+    ;; optional
+    #+ql-https
+    (setf ql-https:*quietly-use-https* t)
+
+
+# AUTHOR
+
+Sebastian Christ (<mailto:rudolfo.christ@pm.me>)
+
+
+# COPYRIGHT
+
+Copyright (c) 2022 Sebastian Christ (rudolfo.christ@pm.me)
+
+
+# LICENSE
+
+Released under the MIT license.
+

README.txt

@@ -1,5 +1,5 @@
 #+STARTUP: showall
-#+EXPORT_FILE_NAME: ../README.txt
+#+EXPORT_FILE_NAME: ../README.md
 #+OPTIONS: toc:nil author:nil
 # This is just the template README. Export to txt to get the real README.
 * NAME
@@ -27,7 +27,7 @@ cat ../version
 
 ** INSTALLATION
 
-1. =mkdir ~/quicklis= and =cd ~/quicklisp=
+1. =mkdir ~/quicklisp= and =cd ~/quicklisp=
 2. Go to [[https://beta.quicklisp.org/client/quicklisp.sexp]] and lookup =:client-tar= URL, download it, verify
    hash and untar.
 3. Clone ql-https from https://github.com/rudolfochrist/ql-https.git to
@@ -36,7 +36,8 @@ cat ../version
 5. Start a fresh REPL and (require 'asdf)
 6. Load =~/common-lisp/ql-https/ql-setup.lisp=
 7. Eval ~(asdf:load-system "ql-https")~
-8. Inspect ~ql-http:*scheme-functions*~ and verify everything was registered properly.
+8. Inspect ~ql-http:*fetch-scheme-functions*~ and verify everything was registered properly. Both =http= and
+   =https= have =ql-https:fetcher= registered.
 9. Connect internet.
 10. Eval ~(quicklisp:setup)~ - use the USE-HTTPS restart if you hit the network.
 
@@ -45,6 +46,10 @@ Removing the /Missing client-info.sexp, using mock info/ warning.
 1. Eval ~(ql:update-client)~
 2. move =~/quicklisp/tmp/client-info.sexp= to =~/quicklisp=
 
+Watch ASCIInema:
+
+#+MARKDOWN: [![asciicast](https://asciinema.org/a/585361.svg)](https://asciinema.org/a/585361)
+
 ** STARTUP
 
 #+begin_src lisp

doc/README.org

@@ -26,7 +26,7 @@
                                     (invoke-restart 'use-https)))))
             (error "We don't use HTTP here!~&URL: ~A" url))
         (use-https ()
-          :report "Retry with HTTP."
+          :report "Retry with HTTPS."
           (apply #'fetcher
                  (format nil "https~A" (subseq url 4))
                  file