[elpa] externals/url-scgi b81666ed2b 38/48: Add README and improve documentation

[ELPA Syncer]

branch: externals/url-scgi
commit b81666ed2b6b5a49532996652e8d7af7132bcd58
Author: Stefan Kangas <stefankangas@gmail.com>
Commit: Stefan Kangas <stefankangas@gmail.com>

    Add README and improve documentation
---
 README.org  | 32 ++++++++++++++++++++++++++++++++
 url-scgi.el | 13 +++++++++----
 2 files changed, 41 insertions(+), 4 deletions(-)

diff --git a/README.org b/README.org
new file mode 100644
index 0000000000..6df5b97f15
--- /dev/null
+++ b/README.org
@@ -0,0 +1,32 @@
+#+TITLE:  url-scgi.el
+#+DATE:   2022-09-22
+#+AUTHOR: Stefan Kangas <stefankangas@gmail.com>
+
+This library add support for SCGI URLs to Emacs.  It is based on url.el, which
+is shipped with Emacs.
+
+The SCGI specification is available 
[[https://python.ca/scgi/protocol.txt][here]].  There is 
[[file:doc/scgi-protocol.txt][a copy]] in this repository.
+
+* Installation
+
+url-scgi.el is available on [[https://elpa.gnu.org/][GNU ELPA]], which is 
enabled by default in Emacs.
+
+Find and install url-sgi.el using this command:
+
+: M-x list-packages
+
+* Usage
+
+ Usage, with xml-rpc.el:
+
+: (require 'url-scgi)
+: (xml-rpc-method-call "scgi://localhost:5000" "some.method")
+
+* Contact
+
+You can find the latest version of url-scgi.el here:
+
+https://www.github.com/skangas/url-scgi
+
+Bug reports, comments, and suggestions are welcome! Send them to Stefan Kangas
+<stefankangas@gmail.com> or report them on GitHub.
diff --git a/url-scgi.el b/url-scgi.el
index bff17ad518..9cbfc034b3 100644
--- a/url-scgi.el
+++ b/url-scgi.el
@@ -1,6 +1,6 @@
-;;; url-scgi.el --- SCGI Uniform Resource Locator retrieval code  -*- 
lexical-binding: t -*-
+;;; url-scgi.el --- SCGI support for url.el  -*- lexical-binding: t -*-
 
-;; Copyright (C) 2011-2022 Stefan Kangas.
+;; Copyright (C) 2011-2022 Stefan Kangas <stefankangas@gmail.com>
 
 ;; Author: Stefan Kangas <stefankangas@gmail.com>
 ;; Version: 0.6
@@ -24,11 +24,16 @@
 
 ;;; Commentary:
 
-;; Support for SCGI URLs.
+;; Support for SCGI URLs in Emacs, with url.el.
 ;;
 ;; The SCGI specification document can be found at:
 ;;
-;; https://python.ca/scgi/protocol.txt
+;;     https://python.ca/scgi/protocol.txt
+;;
+;; Usage, with xml-rpc.el:
+;;
+;;     (require 'url-scgi)
+;;     (xml-rpc-method-call "scgi://localhost:5000" "some.method")
 ;;
 ;; This is heavily based on the url-http.el library.