From 25c847b32b9fc3fcf3f05040fbe83ddb9759d44b Mon Sep 17 00:00:00 2001 From: leo ouyang Date: Mon, 25 Apr 2022 18:58:58 -0400 Subject: [PATCH] updated Readme to include FAQ and a brief explanation of how the whole thing works --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c92bd6e..a2f33e2 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,10 @@ MAKE SURE YOU HAVE COMPLETED THE INSTALLATION STEPS FIRST! 4. This should deploy your code to "https:yourusername.github.io/free-programming-books-search/" ## How It All Works -1. The search function works locally. +1. THERE IS NO DATABASE INVOLVED. Rather, the books are stored in a markdown on [ +free-programming-books](https://ebookfoundation.github.io/free-programming-books/) and is parsed daily by [free-programming-books](https://github.com/EbookFoundation/free-programming-books-parser). The books and all info pertaining to them are stored in a json file called fpb.json. + +2. This Json is downloaded locally and searched locally when the actual search function is used. ## FAQ