aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsotech117 <michael_foiani@brown.edu>2025-08-27 00:29:13 -0400
committersotech117 <michael_foiani@brown.edu>2025-08-27 00:29:13 -0400
commit30189b184a712fac9af38f44e8eef5104635d906 (patch)
tree0b26edc7e86b7a9319ad81ef95a000982a048512
parentdc3971d10f47354803c62a744af2b88acd371130 (diff)
readme formatHEADmaster
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index 84f97e7..a9b26ef 100644
--- a/README.md
+++ b/README.md
@@ -32,8 +32,8 @@ The server will run on the port specified in your `.env` file.
## Usage
The server has two purposes:
-1. Update the stock metrics to the spreadsheet weekly.
-2. Provide a REST API for updating the spreadsheet on demand.
+1. **Update the stock metrics to the spreadsheet weekly.**
+2. **Provide a REST API for updating the spreadsheet on demand.**
The only endpoint is `http://localhost:{env.PORT}/api/update-stock-screener?token=${env.STOCK_SCREENER_AUTH_TOKEN}`.
This is meant to be run in the background but still allows for manual triggering via the API. Obviously, you should secure this endpoint in a production environment.