scripture-guide 1.0.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +21 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -11,6 +11,27 @@ Scripture references generally follow standard conventions for citing the Bible.
11
11
 
12
12
  - This scripture reference parser executes in a JavaScript envrionment. (Both NodeJS and major browsers supported)
13
13
 
14
+ ## Installing
15
+
16
+ Install the package:
17
+ ```
18
+ npm i scripture-guide
19
+ ```
20
+ Import and use the package:
21
+ ```
22
+ import {lookupReference,generateReference} from 'scripture-guide';
23
+
24
+ const verses = lookupReference('Jn 3:16');
25
+ console.log(verses);
26
+ // { query: 'Jn 3:16', ref: 'John 3:16', verse_ids: [ 26137 ] }
27
+ // John 3:16 is the 26137th verse in the Bible
28
+
29
+ const ref = generateReference([ 26137, 26138, 26139 ]);
30
+ console.log(ref);
31
+ // John 3:16-18
32
+
33
+ ```
34
+
14
35
  ## INPUT—Supported Reference Types
15
36
  |**Reference Type**|**Example** |
16
37
  |--|--|
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "scripture-guide",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "description": "A utiltiy for biblical and scripture reference parsing that enables structured queries based on strings of traditional scripture references (e.g. John 3:16). ",
5
5
  "main": "scriptures.js",
6
6
  "scripts": {