X-Git-Url: https://jfr.im/git/uguu.git/blobdiff_plain/6f1e37470b16cbf2a2529e3d33d2c56fd4df6859..0b95d9d192c25ca8c48146c41f6c884df09fca48:/README.md diff --git a/README.md b/README.md index c7f41eb..3149897 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,19 @@ +# Uguu +[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nokonoko_Uguu&metric=alert_status)](https://sonarcloud.io/dashboard?id=nokonoko_Uguu) +[![MIT +licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/nokonoko/uguu/master/LICENSE) +[![Documentation Status](https://docs.uguu.se/img/flat.svg)](https://docs.uguu.se) + + # What is Uguu? -Uguu is a simple lightweight file uploading and sharing platform, with the option for files to expire. +Uguu is a simple lightweight temporary file hosting and sharing platform, but can also be used as a permanent file host. ## Features - One click uploading, no registration required - A minimal, modern web interface -- Drag & drop supported +- Drag & Drop & Paste supported - Upload API with multiple response choices - JSON - HTML @@ -16,31 +23,19 @@ Uguu is a simple lightweight file uploading and sharing platform, with the optio ### Demo -See the real world example at [uguu.se](https://uguu.se). +See the real world site at [uguu.se](https://uguu.se). ## Requirements Original development environment is Nginx + PHP5.3 + SQLite, but is confirmed to -work with Apache 2.4 and newer PHP versions like PHP7.3. - -## Install - -A detailed installation and configuration can be found at [Uguu/Pomf Documentation](https://blog.yeet.nu/blog/uguu-docs). - -## API -To upload using curl or make a tool you can post using: -``` -curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php (JSON Response) -``` -``` -curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=text (Text Response) -``` -``` -curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=csv (CSV Response) -``` -``` -curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=html (HTML Response) -``` +work with Apache 2.4 and newer PHP versions like PHP7.3 and PHP8.0 + +Node is used to compile Uguu. + +## Installation + +Installation and configuration can be found at [Uguu Documentation](https://docs.uguu.se). + ## Getting help @@ -54,8 +49,3 @@ Uguu is based on [Pomf](http://github.com/pomf/pomf) which was written by Emma L Uguu is free software, and is released under the terms of the Expat license. See `LICENSE`. - -## To do in release v1.1.0 -* Mod feature and interface -* Blacklist DB (already exists on Uguu.se, but not in this code) -* Code cleanup