1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/nitter_ynh.git synced 2024-09-03 19:46:24 +02:00
nitter_ynh/README.md

67 lines
2.4 KiB
Markdown
Raw Normal View History

2022-06-19 13:40:17 +02:00
<!--
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.
-->
2021-03-18 04:45:54 +01:00
# Nitter for YunoHost
2021-03-16 23:36:39 +01:00
2023-02-20 22:50:41 +01:00
[![Integration level](https://dash.yunohost.org/integration/nitter.svg)](https://dash.yunohost.org/appci/app/nitter) ![Working status](https://ci-apps.yunohost.org/ci/badges/nitter.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/nitter.maintain.svg)
[![Install Nitter with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=nitter)
2021-03-16 23:36:39 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2022-06-19 13:40:17 +02:00
> *This package allows you to install Nitter quickly and simply on a YunoHost server.
2021-03-16 23:36:39 +01:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2022-06-19 13:40:17 +02:00
A free and open source alternative Twitter front-end focused on privacy and performance.
Inspired by the Invidious project.
2021-03-16 23:36:39 +01:00
2022-06-19 13:40:17 +02:00
### Features
2023-01-06 10:06:21 +01:00
2022-06-19 13:40:17 +02:00
- No JavaScript or ads
- All requests go through the backend, client never talks to Twitter
- Prevents Twitter from tracking your IP or JavaScript fingerprint
- Uses Twitter's unofficial API (no rate limits or developer account required)
- Lightweight (for @nim_lang, 60KB vs 784KB from twitter.com)
- RSS feeds
- Themes
- Mobile support (responsive design)
2021-03-16 23:36:39 +01:00
2023-08-16 22:17:48 +02:00
**Shipped version:** 2023.08.08~ynh1
2022-09-25 15:48:39 +02:00
2022-06-19 13:45:17 +02:00
**Demo:** https://nitter.net/
## Screenshots
![Screenshot of Nitter](./doc/screenshots/screenshot.png)
2022-10-02 17:59:57 +02:00
## :red_circle: Antifeatures
- **Non-free Network Services**: Promotes or depends entirely on a non-free network service.
2022-06-19 13:40:17 +02:00
## Documentation and resources
2021-03-16 23:36:39 +01:00
2022-06-19 13:45:17 +02:00
* Official app website: <https://nitter.net/>
* Official admin documentation: <https://github.com/zedeus/nitter/wiki>
* Upstream app code repository: <https://github.com/zedeus/nitter>
2023-10-31 15:25:01 +01:00
* YunoHost Store: <https://apps.yunohost.org/app/nitter>
2022-06-19 13:40:17 +02:00
* Report a bug: <https://github.com/YunoHost-Apps/nitter_ynh/issues>
2021-03-16 23:36:39 +01:00
## Developer info
2021-03-18 04:45:54 +01:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/nitter_ynh/tree/testing).
2021-03-16 23:36:39 +01:00
To try the testing branch, please proceed like that.
2022-06-19 13:40:17 +02:00
``` bash
2021-03-18 04:45:54 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/nitter_ynh/tree/testing --debug
2021-03-16 23:36:39 +01:00
or
2021-03-18 04:45:54 +01:00
sudo yunohost app upgrade nitter -u https://github.com/YunoHost-Apps/nitter_ynh/tree/testing --debug
2021-03-16 23:36:39 +01:00
```
2022-06-19 13:40:17 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>