EbookFoundation
/
free-programming-books-search
mirror of https://github.com/EbookFoundation/free-programming-books-search.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

updated Readme to include FAQ and a brief explanation of how the whole thing works

pull/21/head
leo ouyang 2022-04-25 18:58:58 -04:00
parent 6420d90c5e
commit 25c847b32b
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -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