Add table of contents and improve format [ci skip]

This commit is contained in:
video-prize-ranch 2022-10-22 20:32:17 -04:00
parent 166d1e68f6
commit 69e7baa594
No known key found for this signature in database
1 changed files with 25 additions and 4 deletions

View File

@ -10,6 +10,28 @@ An alternative frontend for Imgur. Originally based on [rimgu](https://codeberg.
<img alt="Matrix" src="https://img.shields.io/badge/chat-matrix-blue"> <img alt="Matrix" src="https://img.shields.io/badge/chat-matrix-blue">
</a> </a>
## Table of Contents
- [Features](#features)
- [Comparison](#comparison)
- [Speed](#speed)
- [Privacy](#privacy)
- [Instances](#instances)
- [Clearnet](#clearnet)
- [Tor](#tor)
- [Automatically redirect links](#automatically-redirect-links)
- [LibRedirect](#libredirect)
- [GreaseMonkey script](#greasemonkey-script)
- [Redirector](#redirector)
- [Install](#install)
- [Docker (recommended)](#docker-recommended)
- [Automatic updates](#automatic-updates)
- [Build from source](#build-from-source)
- [Requirements](#requirements)
- [Configuration](#configuration)
- [Environment variables](#environment-variables)
- [Contributing](#contributing)
- [License](#license)
## Features ## Features
- Lightweight - Lightweight
- No JavaScript - No JavaScript
@ -76,7 +98,6 @@ To help distribute load, consider using instances other than the official one.
Use [LibRedirect](https://github.com/libredirect/libredirect) to automatically redirect Imgur links to rimgo! Use [LibRedirect](https://github.com/libredirect/libredirect) to automatically redirect Imgur links to rimgo!
- [Firefox](https://addons.mozilla.org/firefox/addon/libredirect/) - [Firefox](https://addons.mozilla.org/firefox/addon/libredirect/)
- [Chromium-based browsers (Brave, Google Chrome)](https://github.com/libredirect/libredirect#install-in-chromium-brave-and-chrome) - [Chromium-based browsers (Brave, Google Chrome)](https://github.com/libredirect/libredirect#install-in-chromium-brave-and-chrome)
- [Edge](https://microsoftedge.microsoft.com/addons/detail/libredirect/aodffkeankebfonljgbcfbbaljopcpdb)
### GreaseMonkey script ### GreaseMonkey script
There is a script to redirect Imgur links to rimgo. There is a script to redirect Imgur links to rimgo.
@ -182,7 +203,7 @@ rimgo can be configured using environment variables. The path to the .env file c
| PRIVACY_DIAGNOSTICS | | | PRIVACY_DIAGNOSTICS | |
## Contributing ## Contributing
Pull requests are welcome! If you have any questions or bug reports, open an [issue](https://codeberg.org/video-prize-ranch/rimgo/issues/new).
Pull requests are welcome! ## License
This software is released under the AGPL-3.0 license. If you make any modifications to the code and distribute it (including use on a network server), you must publicly distribute your changes and release them under the AGPL-3.0.
This software is released under the AGPL 3.0 license. In short, this means that if you make any modifications to the code and then publish the result (e.g. by hosting the result on a web server), you must publicly distribute your changes and declare that they also use AGPL 3.0.