diff --git a/app/README.md b/app/README.md index 329c1df..22e1a2d 100644 --- a/app/README.md +++ b/app/README.md @@ -19,5 +19,5 @@ gatsby develop ## From where does the website fetches the data of the books? -Website fetches the data of the books from `app/src/book.json` file. See [README in utils directory](../utils/README.MD) +Website fetches the data of the books from `app/src/data/books.json` file. See [README in utils directory](../utils/README.MD) for details on how this file is generated. diff --git a/utils/README.MD b/utils/README.MD index d0f5f57..369eb94 100644 --- a/utils/README.MD +++ b/utils/README.MD @@ -1,6 +1,6 @@ -`utils/` mainly contains scripts for generating `app/src/books.json` file from `README.md` +`utils/` mainly contains scripts for generating `app/src/data/books.json` file from `README.md` -## Generating `app/src/books.json` +## Generating `app/src/data/books.json` The website shows name of the book, year, rating, cover, amazon link, etc in book card. Some of the data like name, year, rating etc is present in the [main README.md](../README.md). Other details @@ -12,9 +12,9 @@ The script goes through all the books in [main README.md](../README.md) and star from `Goodreads` and `Google Search` API. And the result is stored in `utils/books.json` and `utils/book_name_to_details.json` (used for caching only). -Once the script completes the run, the `utils/books.json` file is copied to `app/src/books.json` +Once the script completes the run, the `utils/books.json` file is copied to `app/src/data/books.json` manually. -And the website uses the data from `app/src/books.json` for generating the pages. +And the website uses the data from `app/src/data/books.json` for generating the pages. In most cases, you don't want to run the `utils/update_json_files.py` or make changes to it while working on the website. The only time you want to mess with the script is when you want to fetch some extra data from `API` or want to update