Updates for package, node and README (#12)

.nvmrc

@@ -1 +1 @@
-16.4.1
+18.12.1

README.md

@@ -6,41 +6,23 @@ Bubo Reader is a hyper-minimalist <acronym title="Really Simple Syndication">RSS
 
 It is named after this [silly robot owl](https://www.youtube.com/watch?v=MYSeCfo9-NI) from Clash of the Titans (1981).
 
-You can read more about this project on my blog:  
+You can read more about this project on my blog:
+
 - [Introducing Bubo RSS: An Absurdly Minimalist RSS Feed Reader](https://george.mand.is/2019/11/introducing-bubo-rss-an-absurdly-minimalist-rss-feed-reader/).
 - [Publishing Bubos RSS to Netlify with GitHub Actions](https://george.mand.is/2020/02/publishing-bubos-rss-to-netlify-with-github-actions/)
 
-
 ## Get Started
 
-- Clone or fork the repo and run  `npm install` to install the dependencies.
+- Clone or fork the repo and run `npm install` to install the dependencies.
 - Update `feeds.json` to include categories and links to feeds you would like to see.
 - Run `npm run build:bubo`
 
 That's it! You should now have a static page with links to the latest content from your feeds in the `public` folder, ready to serve.
 
 <details>
-<summary>
+  <summary>
-<strong> Differences in Bubo 2.0</strong>
+    <strong>Anatomy of Bubo Reader</strong>
-</summary>
+  </summary>
-
-Version 2.0 has introduced some substantial changes for Bubo! While the static output remains endearingly spartan, the engine that builds it has changed a bit.
-
-Hopefully all of these changes are in services of making this project more useful to others and encouraging outside contributions.
-
-Changes of note:
-
-- Bubo has been rewritten in [TypeScript](https://www.typescriptlang.org/). It's pretty slick! I anticipate the typing could be improved, but it's a start.
-- You will find an `.nvmrc` file in the root of this project. Learn more [about nvm](https://github.com/nvm-sh/nvm) if you're unfamiliar.
-- The script will actually write your `index.html` file for you (Previously the build script simply ran `node src/index.js > output/index.html`). It makes a strong assumption that this file lives in the `public` folder.
-- There is a somewhat sophisticated mechansim in-place for batching & throttling your requests, if needed.
-</details>
-
-
-<details>
-<summary>
- <strong>Anatomy of Bubo Reader</strong>
-</summary>
 
 The static pieces:
 
@@ -54,19 +36,20 @@ The engine:
 - `src/index.ts` - The primary script you run when you want to build a new version of Bubo. It will automatically fetch the latest content from your feeds and build a new static file at `public/index.html`.
 - `src/renderer.ts` — The renderer that loads Nunjucks, the template and understands how to process the incoming feed data. Prefer something else? This is the place to change it!
 - `src/utilities.ts` — A variety of parsing and normalization utilities for Bubo, hidden away to try and keep things clean.
+
 </details>
 
 <details>
-<summary>
+  <summary>
-<strong>Throttling</strong>
+    <strong>Throttling</strong>
-</summary>
+  </summary>
 
-In the main `index.ts` file you will find two values that allow yout to batch and throttle your feed requests:
+In the main `index.ts` file you will find two values that allow you to batch and throttle your feed requests:
 
-- `MAX_CONNECTIONS` dictates the maximium number of requests a batch can have going at once.
+- `MAX_CONNECTIONS` dictates the maximum number of requests a batch can have going at once.
 - `DELAY_MS` dictates the amount of delay time between each batch.
 
-The default configuration is **no batching or throttling** beacuse `MAX_CONNECTIONS` is set to `Infinity`. If you wanted to change Bubo to only fetch one feed at a time every second you could set these values to:
+The default configuration is **no batching or throttling** because `MAX_CONNECTIONS` is set to `Infinity`. If you wanted to change Bubo to only fetch one feed at a time every second you could set these values to:
 
 ```javascript
 const MAX_CONNECTIONS = 1;
@@ -81,18 +64,20 @@ const DELAY_MS = 2500;
 ```
 
 In practice, I've never _really_ run into an issue leaving `MAX_CONNECTIONS` set to `Infinity` but this feels like a sensible safeguard to design.
+
 </details>
 
 <details>
-<summary>
+  <summary>
-<strong>Getting Started</strong>
+    <strong>Getting Started</strong>
-</summary>
+  </summary>
 
 - [Deploying to Glitch](#glitch)
 - [Deploying to Netlify](#netlify)
 - [Keeping feeds updated](#updated)
 
 <a id="glitch"></a>
+
 ## Deploying to Glitch
 
 The quickest way is to remix the project on Glitch:
@@ -103,6 +88,7 @@ There is also a `glitch` branch on this repo if you'd prefer to start there.
 Just change some feeds in `./config/feeds.json` file and you're set! If you'd like to modify the style or the template you can changed `./public/style.css` file or the `./config/template.html` file respectively.
 
 <a id="netlify"></a>
+
 ## Deploying to Netlify
 
 - [Fork the repository](https://github.com/georgemandis/bubo-rss/fork)
@@ -112,6 +98,7 @@ Just change some feeds in `./config/feeds.json` file and you're set! If you'd li
 The deploy settings should automatically import from the `netlify.toml` file. All you'll need to do is confirm and you're ready to go!
 
 <a id="updated"></a>
+
 ### Keeping Feeds Updated
 
 #### Using Netlify Webhooks
@@ -122,17 +109,12 @@ To keep your feeds up to date you'll want to [setup a Build Hook](https://www.ne
 - [Zapier](https://zapier.com/)
 - [EasyCron](https://www.easycron.com/)
 
-#### Using GitHub Actions
-
-Coming soon—there is an old branch that demonstrates this, but it needs to be revisisted in light of Bubo 2.0.
-
 #### Rolling Your Own
 
 If you already have a server running Linux and some command-line experience it might be simpler to setup a [cron job](https://en.wikipedia.org/wiki/Cron).
 
 </details>
 
-
 ## Demos
 
 You can view live demos here:
@@ -140,7 +122,6 @@ You can view live demos here:
 - [https://bubo-rss-demo.netlify.com/](https://bubo-rss-demo.netlify.com/)
 - [http://bubo-rss.glitch.me/](http://bubo-rss.glitch.me/)
 
-
 ## Support
 
 If you found this useful please consider [sponsoring me or this project](https://github.com/sponsors/georgemandis).
@@ -150,6 +131,7 @@ If you'd rather run this on your own server please consider using one of these a
 ## Showcase
 
 Here are some websites using Bubo Reader:
+
 - [Kevin Fiol](https://kevinfiol.com/reader/) ([repo](https://github.com/kevinfiol/reader))
 
 Please share if you would like to be featured!

package.json

@@ -27,19 +27,19 @@
   },
   "license": "MIT",
   "dependencies": {
-    "chalk": "^5.0.0",
+    "chalk": "^5.1.2",
-    "node-fetch": "^3.1.1",
+    "node-fetch": "^3.3.0",
-    "nunjucks": "^3.2.0",
+    "nunjucks": "^3.2.3",
-    "rss-parser": "^3.6.3"
+    "rss-parser": "^3.12.0"
   },
   "devDependencies": {
-    "@types/node": "^16.11.10",
+    "@types/node": "^16.18.4",
-    "@types/nunjucks": "^3.2.0",
+    "@types/nunjucks": "^3.2.1",
-    "@types/xml2js": "^0.4.9",
+    "@types/xml2js": "^0.4.11",
-    "@typescript-eslint/eslint-plugin": "^5.4.0",
+    "@typescript-eslint/eslint-plugin": "^5.45.0",
-    "@typescript-eslint/parser": "^5.4.0",
+    "@typescript-eslint/parser": "^5.45.0",
-    "eslint": "^8.3.0",
+    "eslint": "^8.29.0",
-    "tslib": "^2.3.1",
+    "tslib": "^2.4.1",
-    "typescript": "^4.5.2"
+    "typescript": "^4.9.3"
   }
-}
+}