DR-DinoMight / webmention-rss-discovery-sender

A simple Node Module to read a Feed.xml and run discovery X number of posts to send Webmentions to refrencing links

Welcome to webmention-rss-discovery-sender 👋

A simple webmention discovery and sender tool, that reads feed.xml and sends webmentions to the mentioned links of a post

Install

npm install

Add options to the file or page that you want to process the webmentions for.

  const options : WebmentionOptions = {
    postCount: Number(process.env.WEBMENTION_POST_COUNT) || 1, // Number of posts to process
    feedUrl: process.env.WEBMENTION_FEED_URL, // Eg. https://example.com/feed.xml
    logFileLocation: process.env.WEBMENTION_LOG_LOCATION, // Default: '/webmention-discovery.log'
    domainsToIgnoreString: process.env.WEBMENTION_IGNORED_DOMAINS, // Eg. 'example.com,example.org'
    // dryRun: true // Will not actually post webmentions but will do eveyrthing else including discovery and logging
  }

And call the function:

  const webmentionData = await webmentionDiscovery(options);

Run tests

npm run test

Author

👤 Matthew Peck-Deloughry [e-mail] (https://deloughry.co.uk)

• Website: https://deloughry.co.uk
• Twitter: @DR_DinoMight
• Github: @DR-DinoMight

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2022 Matthew Peck-Deloughry [e-mail] (https://deloughry.co.uk).
This project is MIT licensed.

---

This README was generated with ❤️ by readme-md-generator