Skip to content

Commit 6d3673c

Browse files
committed
include known issues section in README
1 parent e6d046e commit 6d3673c

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# Unlocking Data. A Gentle Introduction to APIs
22

3-
This repository contains the source code for the book "Unlocking Data. A Gentle Introduction to APIs".
4-
5-
The book is built with [Quarto](https://quarto.org/) and relies heavily on [Observable JS](https://quarto.org/docs/interactive/ojs/).
3+
This repository contains the source code for the workbook *Unlocking Data: A Gentle Introduction to APIs*. The workbook introduces readers to the fundamentals of working with APIs through explanations, interactive examples, and practical use cases.
64

5+
The book is built with [Quarto](https://quarto.org/) and relies heavily on [Observable JS](https://quarto.org/docs/interactive/ojs/) to provide live, interactive content.
76

87
## How to publish the book
98

@@ -13,4 +12,6 @@ Publications are done using the `.github/workflows/publish.yml` file, which is t
1312

1413
We opt for execute the code as part of a Github Action, because it allows us to fetch the data from external sources. Updated computations are still stored in `_freeze` folder, and it's recommended using a Python virtual environment to run Quarto and install the required packages using `requirements.txt` file.
1514

15+
## Known issues
1616

17+
- Some Observable JS (OJS) code may not execute correctly during local builds. This issue arises because accessing environment variables in Quarto with OJS is not straightforward. As a result, there is a risk that API keys could inadvertently be exposed in the build output.

0 commit comments

Comments
 (0)