From e29021bd7d5bd4d178b96c622af9b43e082581f4 Mon Sep 17 00:00:00 2001 From: Henrique Dias Date: Sun, 29 Jun 2025 08:31:49 +0200 Subject: [PATCH] docs: make README lighter --- README.md | 44 +++++++++++--------------------------------- 1 file changed, 11 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 47ad6bf4..39c962d6 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,20 @@ -#

-![Preview](https://user-images.githubusercontent.com/5447088/50716739-ebd26700-107a-11e9-9817-14230c53efd2.gif) - [![Build](https://github.com/filebrowser/filebrowser/actions/workflows/main.yaml/badge.svg)](https://github.com/filebrowser/filebrowser/actions/workflows/main.yaml) -[![Go Report Card](https://goreportcard.com/badge/github.com/filebrowser/filebrowser?style=flat-square)](https://goreportcard.com/report/github.com/filebrowser/filebrowser) -[![Documentation](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](http://godoc.org/github.com/filebrowser/filebrowser) -[![Version](https://img.shields.io/github/release/filebrowser/filebrowser.svg?style=flat-square)](https://github.com/filebrowser/filebrowser/releases/latest) -[![Chat IRC](https://img.shields.io/badge/freenode-%23filebrowser-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23filebrowser) +[![Go Report Card](https://goreportcard.com/badge/github.com/filebrowser/filebrowser)](https://goreportcard.com/report/github.com/filebrowser/filebrowser) +[![Documentation](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/filebrowser/filebrowser) +[![Version](https://img.shields.io/github/release/filebrowser/filebrowser.svg)](https://github.com/filebrowser/filebrowser/releases/latest) +[![Chat IRC](https://img.shields.io/badge/freenode-%23filebrowser-blue.svg)](http://webchat.freenode.net/?channels=%23filebrowser) -filebrowser provides a file managing interface within a specified directory and it can be used to upload, delete, preview, rename and edit your files. It allows the creation of multiple users and each user can have its own directory. It can be used as a standalone app. +File Browser provides a file managing interface within a specified directory and it can be used to upload, delete, preview and edit your files. It is a **create-your-own-cloud**-kind of software where you can just install it on your server, direct it to a path and access your files through a nice web interface. + +## Documentation + +Documentation on how to install, configure, and contribute to this project is hosted at [filebrowser.org](https://filebrowser.org). + +## Status > [!WARNING] > @@ -25,28 +28,3 @@ filebrowser provides a file managing interface within a specified directory and [issues]: https://github.com/filebrowser/filebrowser/issues [discussions]: https://github.com/filebrowser/filebrowser/discussions - -## Features - -File Browser is a **create-your-own-cloud-kind** of software where you can install it on a server, direct it to a path and then access your files through a nice web interface. You have many available features! - -| Easy Login System | Sleek Interface | User Management | -| :----------------------: | :----------------------: | :----------------------: | -| ![](docs/assets/1.jpg) | ![](docs/assets/2.jpg) | ![](docs/assets/3.jpg) | - - -| File Editing | Custom Commands | Customization | -| :----------------------: | :----------------------: | :----------------------: | -| ![](docs/assets/4.jpg) | ![](docs/assets/5.jpg) | ![](docs/assets/6.jpg) | - -## Install - -For information on how to install File Browser, please check [installation](docs/installation.md). - -## Configuration - -For information on how to configure File Browser, please check [configuration](docs/configuration.md). - -## Contributing - -For information on how to contribute to the project, including how translations are managed, please check [contributing](docs/contributing.md).