]> jfr.im git - uguu.git/blob - README.md
Update README.md
[uguu.git] / README.md
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
4 licensed](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
10 Uguu is a simple lightweight temporary file hosting and sharing platform, but can also be used as a permanent file host.
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
26 See the real world site at [uguu.se](https://uguu.se).
27
28 ## Requirements
29
30 Original development environment is Nginx + PHP5.3 + SQLite, but is confirmed to
31 work with Apache 2.4 and newer PHP versions like PHP7.3 and PHP8.0
32
33 Node is used to compile Uguu.
34
35 ## Installation
36
37 Installation and configuration can be found at [Uguu Documentation](https://docs.uguu.se).
38
39 If you need a admin panel check out [Moe Panel](https://github.com/pomf/MoePanel).
40
41 ## Getting help
42
43 Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se
44
45 ## Credits
46
47 Uguu 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.
48
49 ## License
50
51 Uguu is free software, and is released under the terms of the Expat license. See
52 `LICENSE`.