webring 1.0.2 → 1.0.3

package/CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.3](https://github.com/shepherdjerred/webring/compare/v1.0.2...v1.0.3) (2024-06-24)
+
+
+### Bug Fixes
+
+* create dir to cache ([a30645c](https://github.com/shepherdjerred/webring/commit/a30645c11d2afe91f7802c91b2c82eef9a97c717))
+
 ## [1.0.2](https://github.com/shepherdjerred/webring/compare/v1.0.1...v1.0.2) (2024-06-21)
 
 

package/README.md

@@ -17,13 +17,13 @@ npm i webring
 
 ## Quick Start
 
-This library is meant to be used with static site generators. It is framework agnostic.
+This library is meant to be used with static site generators. It is framework agnostic. I use this with [Astro](https://astro.build/) on my [personal website](https://github.com/shepherdjerred/sjer.red/blob/main/src/components/BlogWebring.astro#L17-L22).
 
 ```typescript
-import { type Configuration, run } from "webring";
+import { run } from "webring";
+import { type Configuration, type Result } from "webring";
 
-// create a configuration object
-const config: Configuration = {
+export const config: Configuration = {
   sources: [
     {
       url: "https://drewdevault.com/blog/index.xml",
@@ -38,18 +38,39 @@ const config: Configuration = {
       title: "Jake Lazaroff",
     },
   ],
+  // the output will return the three most recent posts from the above sources
   number: 3,
-  cache_duration_minutes: 60,
+  // the output will return santized HTML truncated to 300 characters
   truncate: 300,
+  // if this is defined, we'll cache the results
+  cache: {
+    // the file to use as a cache
+    cache_file: "webring.json",
+    // how long the cache should remain valid for
+    cache_duration_minutes: 60,
+  },
 };
 
-// run the application
-const result = await run(config);
+// type Result = {
+//   title: string,
+//   url: string,
+//   date: Date,
+//   source: {
+//     url: string,
+//     title: string,
+//   },
+//   // this will be undefined if the RSS feed is empty
+//   preview?: string
+// }[]
+export const result: Result = await run(config);
 
-// do something with the results
 result.map((entry) => {
-  console.log(entry);
+  // do something with the results
+  // for example, you might render each item as an HTML block
 });
 ```
 
-I use this with Astro on my [personal website](https://github.com/shepherdjerred/sjer.red/blob/main/src/components/BlogWebring.astro#L17-L22).
+Here's what I do for my blog:
+
+1. Run `map` against the resulting array ([code](https://github.com/shepherdjerred/sjer.red/blob/f72b2b75bf0722ba8ff0fdd45f31c02c2ee5089d/src/components/BlogWebring.astro#L17-L22)).
+1. Render a component for each entry ([code](https://github.com/shepherdjerred/sjer.red/blob/f72b2b75bf0722ba8ff0fdd45f31c02c2ee5089d/src/components/WebringEntry.astro)).

package/dist/cache.js

@@ -14,6 +14,7 @@ async function loadCache({ cache_file }) {
     }
 }
 async function saveCache({ cache_file }, cache) {
+    await fs.mkdir(cache_file.split("/").slice(0, -1).join("/"), { recursive: true });
     await fs.writeFile(cache_file, JSON.stringify(cache));
 }
 function toCacheEntry(result, now) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "webring",
   "type": "module",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "scripts": {
     "prepare": "husky",
     "lint": "eslint src",