-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
78 additions
and
86 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 "<token>")~. | ||
|
||
If you don't wish to use MELPA, you can clone this repo and run | ||
~M-x package-install-file RET </path/to/insert-esv.el> 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters