webmention-rss-discovery-sender
TypeScript icon, indicating that this package has built-in type declarations

0.0.1 • Public • Published

Welcome to webmention-rss-discovery-sender 👋

Version Maintenance License: MIT Twitter: DR_DinoMight

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 matt+npm@deloughry.co.uk (https://deloughry.co.uk)

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2022 Matthew Peck-Deloughry matt+npm@deloughry.co.uk (https://deloughry.co.uk).
This project is MIT licensed.


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

Package Sidebar

Install

npm i webmention-rss-discovery-sender

Weekly Downloads

0

Version

0.0.1

License

MIT

Unpacked Size

28.3 kB

Total Files

14

Last publish

Collaborators

  • mdeloughry