]> jfr.im git - uguu.git/blame_incremental - README.md
Update README.md
[uguu.git] / README.md
... / ...
CommitLineData
1# Uguu
2[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nokonoko_Uguu&metric=alert_status)](https://sonarcloud.io/dashboard?id=nokonoko_Uguu)
3[![MIT
4licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/nokonoko/uguu/master/LICENSE)
5[![Documentation Status](https://docs.uguu.se/img/flat.svg)](https://docs.uguu.se)
6
7
8# What is Uguu?
9
10Uguu is a simple lightweight file uploading and sharing platform, with the option for files to expire.
11
12## Features
13
14- One click uploading, no registration required
15- A minimal, modern web interface
16- Drag & Drop & Paste supported
17- Upload API with multiple response choices
18 - JSON
19 - HTML
20 - Text
21 - CSV
22- Supports [ShareX](https://getsharex.com/) and other screenshot tools
23
24### Demo
25
26See the real world example at [uguu.se](https://uguu.se).
27
28## Requirements
29
30Original development environment is Nginx + PHP5.3 + SQLite, but is confirmed to
31work with Apache 2.4 and newer PHP versions like PHP7.3 and PHP8.0
32
33Node is used to compile Uguu.
34
35## Installation
36
37Installation and configuration can be found at [Uguu Documentation](https://docs.uguu.se).
38
39
40## Getting help
41
42Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se
43
44## Credits
45
46Uguu is based on [Pomf](http://github.com/pomf/pomf) which was written by Emma Lejack & Eric Johansson (nekunekus) and with help from the open source community.
47
48## License
49
50Uguu is free software, and is released under the terms of the Expat license. See
51`LICENSE`.