You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-5Lines changed: 15 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,13 +16,14 @@ This project was developed with assistance from AI tools including [Gab AI](http
16
16
-**Verse Highlighting**: Right-click verses to highlight in one of six colors for study emphasis
17
17
-**Reference Bible**: Use the reference Bible to select from multiple translation options to compare with (ASV, BSB, CSB, ESV, GNV, KJV, LSB, NASB 1995, NASB 2020, NET, NIV, NKJV, NLT); this also sets the translation for Bible Gateway searches and the Verse Analysis popup
18
18
-**Search Integration**: Built-in [Bible Gateway search](https://www.biblegateway.com/usage/) functionality to search for any word or passage
19
+
-**Theming**: Dark/light mode with six color themes
19
20
20
21
### Advanced Features
21
22
-**Highlights Management**: Search and filter highlighted verses by color/content
22
23
-**Keyboard Navigation**: Extensive keyboard shortcuts (F1 to toggle help)
23
24
-**Data Portability**: Import/export highlights, notes, and settings
25
+
-**Local Device Syncing**: Pair devices on your local network to sync your highlights, notes, and settings using a simple, 8-digit code
24
26
-**Responsive Design**: Optimized for both desktop and mobile devices (mobile has limited features)
25
-
-**Theming**: Dark/light mode with six color themes
26
27
27
28
## Markdown Keyboard Shortcuts
28
29
### Basic Formatting (Ctrl/Cmd + Key)
@@ -63,12 +64,13 @@ This project was developed with assistance from AI tools including [Gab AI](http
63
64
|`Alt + E`| Export Data |
64
65
|`Alt + I`| Import Data |
65
66
|`Alt + M`| Export Notes |
67
+
|`Alt + D`| Manual Sync (if devices paired) |
66
68
|`F1`| Show Help Modal |
67
69
68
70
*Note: Hotkeys can be customized in the settings menu*
69
71
70
72
### Study Resources Integration
71
-
The sidebar provides organized access to extensive theological resources (Reformed Theology/Calvinism focused) including:
73
+
The sidebar provides organized access to extensive theological resources (Reformed Theology/Calvinism) including:
72
74
- Online Bible platforms
73
75
- Christian doctrine references
74
76
- Theological resources
@@ -80,8 +82,10 @@ The sidebar provides organized access to extensive theological resources (Reform
80
82
81
83
-**Frontend**: Pure HTML5, CSS3, and Vanilla JavaScript (ES6+)
82
84
-**Libraries**:
83
-
- Marked.js for Markdown processing
84
85
- Font Awesome for icons
86
+
- Marked.js for Markdown processing
87
+
- PeerJS for discovery (local device syncing)
88
+
- Google for STUN servers (local device syncing)
85
89
-**API**: Bible.helloao.org for scripture text, footnotes, and BSB audio
86
90
-**Storage**: LocalStorage for user data persistence
87
91
-**Build**: Use the provided scripts for setup and consistency
@@ -109,15 +113,19 @@ The sidebar provides organized access to extensive theological resources (Reform
109
113
110
114
## Privacy & Data
111
115
112
-
Highlights, notes, and settings are stored locally in your browser.
116
+
No cloud storage: Highlights, notes, and settings are stored locally in your browser and never pass through servers (only signaling for discovery). Device sync is optional.
113
117
114
118
Data that is transmitted to external servers:
115
119
- Bible passage requests are handled by bible.helloao.org
116
120
- Bible Hub (interlinear) and STEP Bible (both when using Verse Analysis popup)
117
121
- Bible Gateway searches
118
122
- Reference Bible websites while the panel is opened
119
123
- Resource links opened in external sites via the sidebar
120
-
- Third-party library usage for Font Awesome and Marked.js
124
+
- Third-party libraries:
125
+
- Font Awesome
126
+
- Marked.js
127
+
- PeerJS
128
+
- Google STUN servers
121
129
122
130
## Attribution
123
131
@@ -126,6 +134,8 @@ Data that is transmitted to external servers:
126
134
- Audio files hosted by [Open Bible](https://openbible.com/audio/)
127
135
- Icons by [Font Awesome](https://fontawesome.com)
128
136
- Markdown processing by [Marked.js](https://cdn.jsdelivr.net/npm/marked/)
137
+
- Local device syncing by [PeerJS](https://unpkg.com)
138
+
- STUN servers by [Google]("stun.l.google.com" and "stun1.l.google.com")
0 commit comments