YunoHost-Apps/proxitok_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/proxitok_ynh.git synced 2024-09-03 20:15:53 +02:00
Code Issues Activity Actions

Auto-update README

Browse source
This commit is contained in:
yunohost-bot 2022-03-29 21:35:10 +00:00
parent 79ae80aef7
commit 1da7c09283
2 changed files with 56 additions and 62 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
README.md
View file

@ -1,48 +1,40 @@
# Packaging an app, starting from this example
- Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
- Edit the `manifest.json` with app specific info.
- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`.
- Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
- Add a `LICENSE` file for the package.
- Edit `doc/DISCLAIMER*.md`
- The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
---
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand. It shall NOT be edited by hand.
--> -->
# Example app for YunoHost # ProxiTok for YunoHost
[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Integration level](https://dash.yunohost.org/integration/proxitok.svg)](https://dash.yunohost.org/appci/app/proxitok) ![](https://ci-apps.yunohost.org/ci/badges/proxitok.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/proxitok.maintain.svg)
[![Install example with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Install ProxiTok with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=proxitok)
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install example quickly and simply on a YunoHost server. > *This package allows you to install ProxiTok quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview ## Overview
Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps) Use Tiktok with an alternative frontend, inspired by Nitter.
**Shipped version:** 1.0~ynh1 ### Features
Privacy: All requests made to TikTok are server-side, so you will never connect to their servers
See user's feed
See trending and discovery tab
See tags
See video by id
Themes
RSS Feed for user, trending and tag (just add /rss to the url)
**Shipped version:** 2.2.0.0~ynh1
**Demo:** https://demo.example.com **Demo:** https://demo.example.com
## Screenshots ## Screenshots
![](./doc/screenshots/screenshot.png)
![](./doc/screenshots/example.jpg)
## Disclaimers / important information ## Disclaimers / important information
@ -59,26 +51,24 @@ Explain in *a few (10~15) words* the purpose of the app or what it actually does
* upgrade process / specificities / things to be aware of ? * upgrade process / specificities / things to be aware of ?
* security considerations ? * security considerations ?
## Documentation and resources ## Documentation and resources
* Official app website: https://example.com * Official app website: proxitok.herokuapp.com
* Official user documentation: https://yunohost.org/apps * Official user documentation: https://yunohost.org/apps
* Official admin documentation: https://yunohost.org/packaging_apps * Official admin documentation: https://yunohost.org/packaging_apps
* Upstream app code repository: https://some.forge.com/example/example * Upstream app code repository: https://github.com/pablouser1/ProxiTok
* YunoHost documentation for this app: https://yunohost.org/app_example * YunoHost documentation for this app: https://yunohost.org/app_proxitok
* Report a bug: https://github.com/YunoHost-Apps/example_ynh/issues * Report a bug: https://github.com/YunoHost-Apps/proxitok_ynh/issues
## Developer info ## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing). Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/proxitok_ynh/tree/testing).
To try the testing branch, please proceed like that. To try the testing branch, please proceed like that.
``` ```
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/proxitok_ynh/tree/testing --debug
or or
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app upgrade proxitok -u https://github.com/YunoHost-Apps/proxitok_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** https://yunohost.org/packaging_apps **More info regarding app packaging:** https://yunohost.org/packaging_apps

56
README_fr.md
View file

@ -1,30 +1,36 @@
# Example app pour YunoHost # ProxiTok pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Niveau d'intégration](https://dash.yunohost.org/integration/proxitok.svg)](https://dash.yunohost.org/appci/app/proxitok) ![](https://ci-apps.yunohost.org/ci/badges/proxitok.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/proxitok.maintain.svg)
[![Installer example avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Installer ProxiTok avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=proxitok)
*[Read this readme in english.](./README.md)* *[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install example quickly and simply on a YunoHost server. > *Ce package vous permet d'installer ProxiTok rapidement et simplement sur un serveur YunoHost.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble ## Vue d'ensemble
Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'objectif est de donner une idée grossière pour des utilisateurs qui naviguent dans un catalogue de 100+ apps) Use Tiktok with an alternative frontend, inspired by Nitter.
**Version incluse:** 1.0~ynh1 ### Features
**Démo:** https://demo.example.com Privacy: All requests made to TikTok are server-side, so you will never connect to their servers
See user's feed
See trending and discovery tab
See tags
See video by id
Themes
RSS Feed for user, trending and tag (just add /rss to the url)
**Version incluse :** 2.2.0.0~ynh1
**Démo :** https://demo.example.com
## Captures d'écran ## Captures d'écran
![](./doc/screenshots/screenshot.png)
![](./doc/screenshots/example.jpg)
## Avertissements / informations importantes ## Avertissements / informations importantes
@ -41,26 +47,24 @@ Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'o
* upgrade process / specificities / things to be aware of ? * upgrade process / specificities / things to be aware of ?
* security considerations ? * security considerations ?
## Documentations et ressources ## Documentations et ressources
* Site official de l'app : https://example.com * Site officiel de l'app : proxitok.herokuapp.com
* Documentation officielle utilisateur: https://yunohost.org/apps * Documentation officielle utilisateur : https://yunohost.org/apps
* Documentation officielle de l'admin: https://yunohost.org/packaging_apps * Documentation officielle de l'admin : https://yunohost.org/packaging_apps
* Dépôt de code officiel de l'app: https://some.forge.com/example/example * Dépôt de code officiel de l'app : https://github.com/pablouser1/ProxiTok
* Documentation YunoHost pour cette app: https://yunohost.org/app_example * Documentation YunoHost pour cette app : https://yunohost.org/app_proxitok
* Signaler un bug: https://github.com/YunoHost-Apps/example_ynh/issues * Signaler un bug : https://github.com/YunoHost-Apps/proxitok_ynh/issues
## Informations pour les développeurs ## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing). Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/proxitok_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit. Pour essayer la branche testing, procédez comme suit.
``` ```
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/proxitok_ynh/tree/testing --debug
or ou
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app upgrade proxitok -u https://github.com/YunoHost-Apps/proxitok_ynh/tree/testing --debug
``` ```
**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps **Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps