Skip to content

Commit

Permalink
Small update to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
arjun-menon authored Aug 6, 2024
1 parent 4049903 commit 6417a4d
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,13 +170,18 @@ must run Alteza with trusted code, or in an isolated container. For example, in
</tr>
<tr>
<td><code>readfile</code></td>
<td>This is just a simple built-in function that reads the contents of a file (assuming `utf-8` encoding) into a string, and returns it.
<td>This is just a simple built-in function that reads the contents of a file (assuming `utf-8` encoding) into a string, and returns it. It does this:

```
with open(file_path, "r", encoding="utf-8") as someFile:
return someFile.read()
```
</td>
<td align="center">✅</td><td align="center">✅</td><td align="center">✅</td><td align="center">✅</td>
</tr>
<tr>
<td><code>sh</code></td>
<td>This exposes entire sh library. The current working directory (CWD) would be wherever the file being executed is located (regardless of whether the file is a regular page or index page or `__config__.py`, etc). If the file is a template, the CWD would be that of the page being processed.
<td>This exposes entire <code>sh</code> library. The current working directory (CWD) would be wherever the file being executed is located (regardless of whether the file is a regular page or index page or `__config__.py`, etc). If the file is a template, the CWD would be that of the page being processed.

See `sh`'s documentation here: https://sh.readthedocs.io/en/latest/
</td>
Expand Down

0 comments on commit 6417a4d

Please sign in to comment.