lnreader-plugins/README.md

LNReader Plugins

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

Installing

• Prerequisites: Nodejs >= 18

1. npm install
2. Create config.json file in root dir

{
	"githubUsername": "<username>",
	"githubRepository": "<repo>",
	"githubBranch": "<branch>"
}

Example

{
	"githubUsername": "LNReader",
	"githubRepository": "lnreader-sources",
	"githubBranch": "master"
}

Contributing

1. Choose your language in plugins
2. Write your scripts

Examples:

• Hako
• Multisrc: multisrc

Testing

• If you are making a multisrc: npm run generate
• npm start
• Open http://localhost:3000 and test

If you want to test in app side.

• Commit and push changes. Check your own json files in github fork: .dist/<username>/

• Change these in pluginManager.ts (app repo) to yours

const  githubUsername = 'LNReader';
const  githubRepository = 'lnreader-sources';
const  githubBranch = 'master';

• Note: No need to modify .dist folder when opening PR. There's already action for that job.

---

The developer of this application does not have any affiliation with the content providers available.