From 419b6f02a59c4d1a762b8ff22504e079f11ccbad Mon Sep 17 00:00:00 2001 From: Simon Date: Tue, 22 Aug 2023 20:54:38 +0700 Subject: [PATCH] add user script links --- CONTRIBUTING.md | 11 +++++++++++ README.md | 5 +++++ 2 files changed, 16 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bd8d5214..86ad7c0f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,6 +9,7 @@ Welcome, and thanks for showing interest in improving Tube Archivist! - [Installation Help](#installation-help) - [How to make a Pull Request](#how-to-make-a-pull-request) - [Contributions beyond the scope](#contributions-beyond-the-scope) +- [User Scripts](#user-scripts) - [Improve to the Documentation](#improve-to-the-documentation) - [Development Environment](#development-environment) --- @@ -105,6 +106,16 @@ Beyond that, general rules to consider: --- +## User Scripts +Some of you might have created useful scripts or API integrations around this project. Sharing is caring! Please add a link to your script to the Readme [here](https://github.com/tubearchivist/tubearchivist#user-scripts). +- Your repo should have a `LICENSE` file with one of the common open source licenses. People are expected to fork, adapt and build upon your great work. +- Your script should not modify the *official* files of Tube Archivist. E.g. your symlink script should build links *outside* of your `/youtube` folder. Or your fancy script that creates a beautiful artwork gallery should do that *outside* of the `/cache` folder. Modifying the *official* files and folders of TA are probably not supported. +- On the top of the repo you should have a mention and a link back to the Tube Archivist repo. Clearly state to **not** to open any issues on the main TA repo regarding your script. +- Example template: + - `[/](https://linktoyourrepo.com)`: A short one line description. + +--- + ## Improve to the Documentation The documentation available at [docs.tubearchivist.com](https://docs.tubearchivist.com/) and is build from a separate repo [tubearchivist/docs](https://github.com/tubearchivist/docs). The Readme has additional instructions on how to make changes. diff --git a/README.md b/README.md index c5203608..3c8ef609 100644 --- a/README.md +++ b/README.md @@ -174,6 +174,11 @@ Implemented: - [X] Backup and restore [2021-09-22] - [X] Scan your file system to index already downloaded videos [2021-09-14] +## User Scripts +This is a list of useful user scripts, generously created from folks like you to extend this project and its functionality. This is your time to shine, [read this](https://github.com/tubearchivist/tubearchivist/blob/master/CONTRIBUTING.md#user-scripts) then open a PR to add your script here. + +- Example 1 + ## Donate The best donation to **Tube Archivist** is your time, take a look at the [contribution page](CONTRIBUTING.md) to get started. Second best way to support the development is to provide for caffeinated beverages: