More example comments

chore(deps-dev): bump esbuild from 0.24.2 to 0.25.0

CHANGELOG.md

@@ -7,7 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
-## [v3.0.0](https://github.com/bcomnes/deploy-to-neocities/compare/v2.0.4...v3.0.0)
+## [v3.0.2](https://github.com/bcomnes/deploy-to-neocities/compare/v3.0.1...v3.0.2)
+
+### Merged
+
+- chore(deps): bump async-neocities from 4.0.4 to 4.1.0 [`#210`](https://github.com/bcomnes/deploy-to-neocities/pull/210)
+
+## [v3.0.1](https://github.com/bcomnes/deploy-to-neocities/compare/v3.0.0...v3.0.1) - 2024-11-28
+
+### Merged
+
+- chore(deps): bump async-neocities from 4.0.3 to 4.0.4 [`#209`](https://github.com/bcomnes/deploy-to-neocities/pull/209)
+- fixed a typo in README.md [`#208`](https://github.com/bcomnes/deploy-to-neocities/pull/208)
+- chore(deps-dev): bump typescript from 5.6.3 to 5.7.2 [`#207`](https://github.com/bcomnes/deploy-to-neocities/pull/207)
+- Add my website https://jefbecker.com/ to the list. [`#206`](https://github.com/bcomnes/deploy-to-neocities/pull/206)
+
+### Commits
+
+- Update README.md [`15eb88d`](https://github.com/bcomnes/deploy-to-neocities/commit/15eb88d4831e8b3170195c1e2b468e8ab3a9703d)
+
+## [v3.0.0](https://github.com/bcomnes/deploy-to-neocities/compare/v2.0.4...v3.0.0) - 2024-11-19
 
 ### Merged
 
@@ -320,8 +339,8 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 ### Commits
 
-- Fix static deploy stuff with bandaid [`fea2d47`](https://github.com/bcomnes/deploy-to-neocities/commit/fea2d4780c7a98bcdf5738c1c259d66ff115326a)
 - Update site build and ncc [`def67b4`](https://github.com/bcomnes/deploy-to-neocities/commit/def67b48c6e28d4544d8dd2bd92ab53f56856e40)
+- Fix static deploy stuff with bandaid [`fea2d47`](https://github.com/bcomnes/deploy-to-neocities/commit/fea2d4780c7a98bcdf5738c1c259d66ff115326a)
 
 ## [v1.1.1](https://github.com/bcomnes/deploy-to-neocities/compare/v1.1.0...v1.1.1) - 2021-08-20
 

README.md

@@ -32,9 +32,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+    # The checkout step copies your repo into the action runner. Important!
     - uses: actions/checkout@v4
     # Set up any tools and build steps here
     # This example uses a Node.js toolchain to build a site
+    # If you don't need Node.js to build your site, you can omit this.
     - name: Use Node.js
       uses: actions/setup-node@v4
       with:
@@ -45,6 +47,7 @@ jobs:
         npm i
         npm run build
     # When the dist_dir is ready, deploy it to neocities
+    # Here we deploy the folder named `public`
     - name: Deploy to neocities
       uses: bcomnes/deploy-to-neocities@v3
       with:
@@ -66,7 +69,7 @@ You'll need the API token for your site. Go to:
 https://neocities.org/settings/{{your-sitename}}#api_key
 ```
 
-Get your site's API token. In your GitHub repository, set a [secret][sec] called `NEOCITIES_API_TOKEN`.  Set the `api_token` input on your `deploy-to-neocities` action to `${{ secrets.NEOCITIES_API_TOKEN }}` as in the example above.
+Retreive your site's API token from Neocities. In your GitHub repository, set a [secret][sec] called `NEOCITIES_API_TOKEN`.  Set the `api_token` input on your `deploy-to-neocities` action to `${{ secrets.NEOCITIES_API_TOKEN }}` as in the example above. The setting (as of writing) lives in Repository > Settings > Security > Secrets and Variables > Actions > Repository secrets.
 
 During your workflow, generate the files you want to deploy to [Neocities][nc] into a directory. Set this as the `dist_dir` directory in your workflow (the default is `public`).  You can use any tools to generate your site that can be installed or brought into the Github actions environment.
 
@@ -76,9 +79,9 @@ You most likely only want to run this on the `master` branch so that only change
 
 ### Inputs
 
-- `api_token` (**REQUIRED**): The API token for your [Neocities][nc] website to deploy to.
+- `api_key` (**REQUIRED**): The API token for your [Neocities][nc] website to deploy to.
 - `dist_dir`: The directory to deploy to [Neocities][nc]. Default: `public`. Don't deploy your root repo directory (e.g. `./`). It contains `.git`, `.github` and other files that won't deploy properly to neocities. Keep it clean by keeping or building your site into a subdir and deploy that.
-- `neocoties_supporter`: Set this to `true` if you have a paid neocities account and want to bypass the [unsupported files filter](https://neocities.org/site_files/allowed_types).
+- `neocities_supporter`: Set this to `true` if you have a paid neocities account and want to bypass the [unsupported files filter](https://neocities.org/site_files/allowed_types).
 - `cleanup`:  Boolean string (`true` or `false`).  If `true`, `deploy-to-neocities` will destructively delete files found on [Neocities][nc] not found in your `dist_dir`.  Default: `false`.
 - `preview_before_deploy`: Boolean string (`true` or `false`).  If `true`, `deploy-to-neocities` will print a preview of the files that will be uploaded and deleted.  Default: `true`.
 - `protected_files`: An optional glob string used to mark files as protected.  Protected files are never cleaned up.  Test this option out with `cleanup` set to false before relying on it.  Protected files are printed when `cleanup` is set to true or false.  Glob strings are processed by [minimatch](https://github.com/isaacs/minimatch) against remote neocities file paths.  Protected files can still be updated.
@@ -151,6 +154,7 @@ None.
 - https://sacred.neocities.org/ (https://github.com/M-Valentino/sacredOS)
 - https://lenp.net/ (https://github.com/Len42/web-site)
 - <https://punkfairie.net> (<https://github.com/punkfairie/punkfairie-site>)
+- https://github.com/jefbecker/jefbecker.com ([jefbecker.com](https://jefbecker.com))
 - [See more!](https://github.com/bcomnes/deploy-to-neocities/network/dependents)
 - ...PR your site when you set it up!
 

package.json

@@ -1,14 +1,14 @@
 {
   "name": "deploy-to-neocities",
   "description": "Github Action to deplpoy a folder to Neocities.org",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "author": "Bret Comnes <bcomnes@gmail.com> (https://bret.io/)",
   "bugs": {
     "url": "https://github.com/bcomnes/deploy-to-neocities/issues"
   },
   "dependencies": {
     "@actions/core": "1.11.1",
-    "async-neocities": "4.0.3",
+    "async-neocities": "4.1.0",
     "minimatch": "10.0.1"
   },
   "devDependencies": {
@@ -17,10 +17,10 @@
     "auto-changelog": "^2.0.0",
     "gh-release": "^7.0.0",
     "npm-run-all2": "^7.0.0",
-    "neostandard": "^0.11.8",
+    "neostandard": "^0.12.0",
     "c8": "^10.0.0",
-    "esbuild": "~0.24.0",
+    "esbuild": "~0.25.0",
-    "typescript": "~5.6.2"
+    "typescript": "~5.7.2"
   },
   "homepage": "https://github.com/bcomnes/deploy-to-neocities#readme",
   "keywords": [],