From 3ef48fba6708edd25feb111db27f02538be341d3 Mon Sep 17 00:00:00 2001 From: aptalca Date: Mon, 13 Jul 2020 12:17:32 -0400 Subject: [PATCH] update readme on docker mod --- README.md | 21 ++++----------------- readme-vars.yml | 21 ++++----------------- 2 files changed, 8 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 441df9d..2670d93 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,7 @@ -[linuxserverurl]: https://linuxserver.io -[forumurl]: https://forum.linuxserver.io +# Calibre - Docker mod for calibre-web -[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png?v=4&s=4000)][linuxserverurl] +This mod adds the calibre binary to calibre-web (**x86-64 only**) for ebook conversions. -## Contact information:- +In calibre-web docker arguments, set an environment variable `DOCKER_MODS=linuxserver/calibre-web:calibre` to enable. -| Type | Address/Details | -| :---: | --- | -| Discord | [Discord](https://discord.gg/YWrKVTn) | -| Forum | [Linuserver.io forum][forumurl] | - -  -  - -The code in this branch is not meant for direct consumption it is a modification layer to inject the calibre binary and dependancies into the x86 variant of `linuxserver/calibre-web` - -The following line is only in this repo for release messaging: - -- { date: "01.01.50:", desc: "I am the release message for this custom branch" } +If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/calibre-web:calibre|linuxserver/mods:other-mod` diff --git a/readme-vars.yml b/readme-vars.yml index ab16b3f..9387ec6 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -4,24 +4,11 @@ project_name: calibre-web full_custom_readme: | {% raw -%} - [linuxserverurl]: https://linuxserver.io - [forumurl]: https://forum.linuxserver.io + # Calibre - Docker mod for calibre-web - [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png?v=4&s=4000)][linuxserverurl] + This mod adds the calibre binary to calibre-web (**x86-64 only**) for ebook conversions. - ## Contact information:- + In calibre-web docker arguments, set an environment variable `DOCKER_MODS=linuxserver/calibre-web:calibre` to enable. - | Type | Address/Details | - | :---: | --- | - | Discord | [Discord](https://discord.gg/YWrKVTn) | - | Forum | [Linuserver.io forum][forumurl] | - -   -   - - The code in this branch is not meant for direct consumption it is a modification layer to inject the calibre binary and dependancies into the x86 variant of `linuxserver/calibre-web` - - The following line is only in this repo for release messaging: - - - { date: "01.01.50:", desc: "I am the release message for this custom branch" } + If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/calibre-web:calibre|linuxserver/mods:other-mod` {%- endraw %}