Static API clarification.

Author: ntoll

README.md

@@ -34,26 +34,35 @@ This page will display three possible states:
 
 ## API
 
-The PyScript Packages website offers a simple API to access package information programmatically.
+The PyScript Packages website offers a simple 
+[static API](https://www.seancdavis.com/posts/lets-talk-about-static-apis/) to 
+access package information programmatically.
 
-Retrieve the status and metadata of packages in JSON format by making a GET request to the following endpoint:
+Retrieve the status and metadata of packages in JSON format by making a GET
+request to the following endpoint:
 
 ```
 GET /api/package/<package_name>.json
 ```
 
-This will return a JSON object containing the following metadata (or respond with a 404 status code if the package is not found):
+This will return a JSON object containing the following metadata (or respond 
+with a 404 status code if the package is not found):
 
 
 * *status*: The support status of the package (e.g., "green", "amber", "red").
 * *summary*: The summary of the package from PyPI.
-* *notes*: Brief notes, in Markdown, about the package's compatibility with PyScript.
-* *pyodide_versions*: A description of Pyodide/PyScript version support for each version of the package.
-* *updated_by*: The name or handle of the person who last updated this information.
-* *updated_at*: The ISO 8601 timestamp of when this information was last updated.
+* *notes*: Brief notes, in Markdown, about the package's compatibility with 
+  PyScript.
+* *pyodide_versions*: A description of Pyodide/PyScript version support for 
+  each version of the package.
+* *updated_by*: The name or handle of the person who last updated this
+  information.
+* *updated_at*: The ISO 8601 timestamp of when this information was last
+  updated.
 
 
-For example, in Python, you can use the `requests` library to fetch such data about the `pandas` package:
+For example, in Python, you can use the `requests` library to fetch such data
+about the `pandas` package:
 
 ```
 import requests
@@ -66,7 +75,8 @@ else:
     print("Package not found or API error.")
 ```
 
-If you wish to access data for all packages at once, you can use the following endpoint:
+If you wish to access data for all packages at once, you can use the following
+endpoint:
 
 ```
 GET api/all.json

help/index.html

@@ -81,15 +81,15 @@ <h2 id="contribute">How do I contribute?</h2>
 
                     <h2 id="api">Our API</h2>
 
-                    <p>The PyScript Packages website offers a simple API to access package information programmatically.</p>
+                    <p>The PyScript Packages website offers a simple <a href="https://www.seancdavis.com/posts/lets-talk-about-static-apis/" target="_blank">static API</a> to access package information programmatically.</p>
 
                     <p>Retrieve the status and metadata of packages in JSON format by making a GET request to the following endpoint:</p>
 
                     <pre><code>
-GET /api/package/&lt;package_name&gt;.json
+GET api/package/&lt;package_name&gt;.json
                     </code></pre>
 
-                    <p>This will return a JSON object containing the following metadata (or respond with a 404 status code if the package is not found):</p>
+                    <p>This will return a JSON object containing the following metadata (or respond with a 404 status code if the package's status is unknown):</p>
 
                     <ul>
                         <li><strong>status</strong>: The support status of the package (e.g., "green", "amber", "red").</li>
@@ -115,13 +115,13 @@ <h2 id="api">Our API</h2>
                     <p>If you wish to access data for all packages at once, you can use the following endpoint:</p>
 
                     <pre><code>
-GET /api/all.json
+GET api/all.json
                     </code></pre>
 
                     <p>Data about the top 100 packages is also available through this endpoint:</p>
 
                     <pre><code>
-GET /api/top_100_pypi_packages.json
+GET api/top_100_pypi_packages.json
                     </code></pre>
 
                     <p>That's it!</p>