From 8a09629bfafa87f8cd75e92fee6655cfa8be67f2 Mon Sep 17 00:00:00 2001
From: Sam <69141672+sam-sam030820@users.noreply.github.com>
Date: Fri, 7 Aug 2020 18:03:13 +0100
Subject: [PATCH] 0.1.0: refactor readme to org-mode
---
README.md | 45 ------------------------------
README.org | 42 ++++++++++++++++++++++++++++
insert-esv.el | 77 ++++++++++++++++++++++++---------------------------
3 files changed, 78 insertions(+), 86 deletions(-)
delete mode 100644 README.md
create mode 100644 README.org
diff --git a/README.md b/README.md
deleted file mode 100644
index 3dc92d5..0000000
--- a/README.md
+++ /dev/null
@@ -1,45 +0,0 @@
-**insert-esv is an Emacs package for inserting ESV Bible passages.**
-
-
-
-## Installation
-
-insert-esv is available from [MELPA](https://melpa.org/#/getting-started).
-
-1. Run `M-x package-install RET insert-esv RET` to install the package.
-2. Grab an API key from [Crossway](https://api.esv.org/docs/).
-3. Add the API key to your init file:
- `(setq insert-esv-crossway-api-key "")`.
-
-If you don't wish to use MELPA, you can clone this repo and
-run `M-x package-install-file RET RET`.
-
-## Usage
-
-1. Set a keybind in your init file:
- `(global-set-key (kbd "C-x C-e") #'insert-esv-passage)`.
-2. Alternatively, run it from the minibuffer:
- `M-x insert-esv-passage RET`.
-3. Enter a Bible reference (e.g. "Matthew 6:33") and hit `RET`
- to insert it at cursor point.
-
-## Options
-
-* insert-esv contains support for the optional parameters in
- Crossway's [Passage Text API](https://api.esv.org/docs/passage-text/).
-* You can customise these parameters in your init file.
-* Make sure to prefix the parameter with "insert-esv", like this:
- `(setq insert-esv-include-headings 'true)`.
-
-## Disclaimer
-
-* insert-esv is licensed under
- [GPLv3](https://github.com/sam030820/insert-esv/blob/master/COPYING).
-* Scripture quotations are from the ESV® Bible, copyright © 2001
- by Crossway, a publishing ministry of Good News Publishers.
-
-## Changelog
-
-### [0.1.0] - 2020-08-07
-#### Added
-* Initial release
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..3e91c04
--- /dev/null
+++ b/README.org
@@ -0,0 +1,42 @@
+#+AUTHOR: sam030820
+#+DATE: <2020-08-07 Fri>
+#+LANGUAGE: en
+
+*insert-esv is an Emacs package for inserting ESV Bible passages.*
+
+** Installation
+insert-esv is available from [[https://melpa.org/#/getting-started][MELPA]].
+
+1. Run ~M-x package-install RET insert-esv RET~ to install the package.
+2. Grab an API key from [[https://api.esv.org/docs/][Crossway]].
+3. Add the API key to your init file:
+ ~(setq insert-esv-crossway-api-key "")~.
+
+If you don't wish to use MELPA, you can clone this repo and run
+~M-x package-install-file RET RET~.
+
+** Usage
+1. Set a keybind in your init file:
+ ~(global-set-key (kbd "C-x C-e") #'insert-esv-passage)~.
+2. Alternatively, run it from the minibuffer:
+ ~M-x insert-esv-passage RET~.
+3. Enter a Bible reference (e.g. "Matthew 6:33") and hit ~RET~ to insert
+ it at cursor point.
+
+** Options
+- insert-esv contains support for the optional parameters in Crossway's
+ [[https://api.esv.org/docs/passage-text/][Passage Text API]].
+- You can customise these parameters in your init file.
+- Make sure to prefix the parameter with "insert-esv", like this:
+ ~(setq insert-esv-include-headings 'true)~.
+
+** Disclaimer
+- insert-esv is licensed under
+ [[https://github.com/sam030820/insert-esv/blob/master/COPYING][GPLv3]].
+- Scripture quotations are from the ESV® Bible, copyright © 2001 by
+ Crossway, a publishing ministry of Good News Publishers.
+
+** Changelog
+*** [0.1.0] - 2020-08-07
+**** Added
+- Initial release
diff --git a/insert-esv.el b/insert-esv.el
index 5f23de3..6e7157d 100644
--- a/insert-esv.el
+++ b/insert-esv.el
@@ -24,50 +24,45 @@
;; along with this program. If not, see .
;;; Commentary:
-
-;; **InsertESV is an Emacs package for inserting ESV Bible passages.**
-
-;;;; ## Installation
-
-;; insert-esv is available from [MELPA](https://melpa.org/#/getting-started).
-
-;; 1. Run `M-x package-install RET insert-esv RET` to install the package.
-;; 2. Grab an API key from [Crossway](https://api.esv.org/docs/).
+;;
+;; *insert-esv is an Emacs package for inserting ESV Bible passages.*
+;;
+;; ** Installation
+;; insert-esv is available from [[https://melpa.org/#/getting-started][MELPA]].
+;;
+;; 1. Run ~M-x package-install RET insert-esv RET~ to install the package.
+;; 2. Grab an API key from [[https://api.esv.org/docs/][Crossway]].
;; 3. Add the API key to your init file:
-;; `(setq insert-esv-crossway-api-key "")`.
-
-;; If you don't wish to use MELPA, you can clone this repo and
-;; run `M-x package-install-file RET RET`.
-
-;;;; ## Usage
-
+;; ~(setq insert-esv-crossway-api-key "")~.
+;;
+;; If you don't wish to use MELPA, you can clone this repo and run
+;; ~M-x package-install-file RET RET~.
+;;
+;; ** Usage
;; 1. Set a keybind in your init file:
-;; `(global-set-key (kbd "C-x C-e") #'insert-esv-passage)`.
+;; ~(global-set-key (kbd "C-x C-e") #'insert-esv-passage)~.
;; 2. Alternatively, run it from the minibuffer:
-;; `M-x insert-esv-passage RET`.
-;; 3. Enter a Bible reference (e.g. "Matthew 6:33") and hit `RET`
-;; to insert it at cursor point.
-
-;;;; ## Options
-
-;; * InsertESV contains support for the optional parameters in
-;; Crossway's [Passage Text API](https://api.esv.org/docs/passage-text/).
-;; * You can customise these parameters in your init file.
-;; * Make sure to prefix the parameter with "insert-esv", like this:
-;; `(setq insert-esv-include-headings 'true)`.
-
-;;;; ## Disclaimer
-
-;; * InsertESV is licensed under
-;; [GPLv3](https://github.com/sam030820/insert-esv/blob/master/COPYING).
-;; * Scripture quotations are from the ESV® Bible, copyright © 2001
-;; by Crossway, a publishing ministry of Good News Publishers.
-
-;;;; ## Changelog
-
-;; ### [0.1.0] - 2020-08-07
-;; #### Added
-;; * Initial release
+;; ~M-x insert-esv-passage RET~.
+;; 3. Enter a Bible reference (e.g. "Matthew 6:33") and hit ~RET~ to insert
+;; it at cursor point.
+;;
+;; ** Options
+;; - insert-esv contains support for the optional parameters in Crossway's
+;; [[https://api.esv.org/docs/passage-text/][Passage Text API]].
+;; - You can customise these parameters in your init file.
+;; - Make sure to prefix the parameter with "insert-esv", like this:
+;; ~(setq insert-esv-include-headings 'true)~.
+;;
+;; ** Disclaimer
+;; - insert-esv is licensed under
+;; [[https://github.com/sam030820/insert-esv/blob/master/COPYING][GPLv3]].
+;; - Scripture quotations are from the ESV® Bible, copyright © 2001 by
+;; Crossway, a publishing ministry of Good News Publishers.
+;;
+;; ** Changelog
+;; *** [0.1.0] - 2020-08-07
+;; **** Added
+;; - Initial release
;;; Code: