lnreader-plugins/README.md

LNReader Plugins

Repository to host plugins and related issues, and requests for LNReader.

Installing

• Prerequisites: Nodejs >= 20

1. npm install

Contributing

• Quick start
• Documentation

Testing

via the testing website

1. Run npm run dev:start and open localhost:3000 to test!

Detailed tutorial for testing website

via an app

1. Plugins from GitHub
   • Run npm run publish:plugins or npm run publish:plugins:windows (depending on your operating system)
   • Add your https://raw.githubusercontent.com/<username>/<repo>/plugins/<tag>/.dist/plugins.min.json to app repository
2. Plugins from localhost
   • Copy .env.template to .env and update USER_CONTENT_BASE according to the comment there
   • Run npm run serve:dev
   • Add plugin listing to app repository (e.g. for android emulator http://10.0.2.2/.dist/plugins.min.json)

---

The developers of this application are not affiliated with any of the content providers.

If you are a website owner and would like to have a plugin removed from this repository, please reach out via Discord or create a GitHub issue. We will promptly remove the plugin and add your site to the blacklist to prevent it from being re-added.