From 7c2665e2ecdab1a81ccc518c3e6a2dde989f9f0d Mon Sep 17 00:00:00 2001
From: Andros Fenollosa <andros@fenollosa.email>
Date: Tue, 13 Jun 2023 10:11:28 +0200
Subject: [PATCH] Add readme

---
 README.md           | 15 +++++++++++++++
 org-share-to-web.el |  2 +-
 2 files changed, 16 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2f0bfec
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+## Configure
+
+Configure the domain to be used to access the file share and the directory where it will be hosted using Tramp.
+
+```elisp
+(setq org-share-to-web-domain "")
+(setq org-share-to-web-directory "")
+```
+
+Example.
+
+```elisp
+(setq org-share-to-web-domain "https://mydomain.com/")
+(setq org-share-to-web-directory "/ssh:debian@mydomain.com:~/www/")
+```
diff --git a/org-share-to-web.el b/org-share-to-web.el
index fae7f73..29f7aa2 100644
--- a/org-share-to-web.el
+++ b/org-share-to-web.el
@@ -7,7 +7,7 @@
 ;; SPDX-License-Identifier: GPL-3.0-or-later
 
 ;;; Commentary:
-;;
+;; Share a Org document in an HTML document accessible online.
 
 ;;; Code: