Start adding documation and add host.ps1 for windows users (#725)
* Add docs v0.0.1 * Add icon size warning * Fix sourcenover caution * Fix semver descriptions * Filters fix * Quickfix quickstart * Add icon warning v2 * Fix typos * Add NovelItem * Update plugins host * Update plugins host * Remove unnecesarry .js and .dist * Update plugins host * Add host.ps1 * Fix readme.txt * Fix READNE.txt, again * Remove .js and .dist * readme update with ost * Add linux/windows hosting functions * Fix workflows
This commit is contained in:
@@ -1,61 +1,42 @@
|
||||
|
||||
|
||||
# LNReader Plugins
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
|
||||
|
||||
|
||||
<img alt="GitHub issues by-label" src="https://img.shields.io/github/issues/lnreader/lnreader-sources/Source%20Request?color=success&label=source%20requests">
|
||||
|
||||
|
||||
|
||||
<img alt="GitHub issues by-label" src="https://img.shields.io/github/issues/lnreader/lnreader-sources/Bug?color=red&label=bugs">
|
||||
|
||||
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
Repository to host plugins and related issues, and requests for [LNReader](https://github.com/LNReader/lnreader).
|
||||
Repository to host plugins and related issues, and requests for
|
||||
[LNReader](https://github.com/LNReader/lnreader).
|
||||
|
||||
## Installing
|
||||
|
||||
- Prerequisites: Nodejs >= 18
|
||||
- Prerequisites: Nodejs >= 18
|
||||
|
||||
1. `npm install`
|
||||
|
||||
## Contributing
|
||||
|
||||
1. Choose your language in [plugins](./plugins)
|
||||
2. Write your scripts
|
||||
|
||||
|
||||
|
||||
## Examples:
|
||||
+ [Hako](./plugins/vietnamese/LNHako.ts)
|
||||
+ Multisrc: [multisrc](./scripts/multisrc)
|
||||
- [Quick start](./docs/quickstart.md)
|
||||
- [Documentation](./docs/docs.md)
|
||||
|
||||
## Testing
|
||||
- If you are making a [multisrc](./scripts/multisrc): `npm run generate`
|
||||
- `npm start`
|
||||
- Open http://localhost:3000 and test
|
||||
|
||||
### If you want to test in app side.
|
||||
#### via the testing website
|
||||
|
||||
- `./host.sh`
|
||||
1. Run `npm start` and open `localhost:3000` to test!
|
||||
|
||||
- Change these in [pluginManager.ts](https://github.com/LNReader/lnreader/blob/master/src/plugins/pluginManager.ts) (app repo) to yours
|
||||
[Detailed tutorial for testing website](./docs/website-tutorial.md)
|
||||
|
||||
|
||||
#### via an app
|
||||
|
||||
1. Run `npm run host-linux` or `npm run host-windows` (depending on your operating system)
|
||||
2. Change the values in [pluginManager.ts](https://github.com/LNReader/lnreader/blob/master/src/plugins/pluginManager.ts) (in-app) to yours
|
||||
|
||||
```ts
|
||||
const githubUsername = 'LNReader';
|
||||
const githubRepository = 'lnreader-sources';
|
||||
const githubUsername = "LNReader";
|
||||
const githubRepository = "lnreader-sources";
|
||||
```
|
||||
----------
|
||||
|
||||
|
||||
---
|
||||
|
||||
The developer of this application does not have any affiliation with the content providers available.
|
||||
|
||||
Reference in New Issue
Block a user