]> jfr.im git - uguu.git/blobdiff - README.md
Update Makefile
[uguu.git] / README.md
index eb73ae570e509ef62785fcfd73330c3f82ba0f57..c6d7fcba0ed73ce7e4c4487e77014abc4f65c30a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,24 +1,28 @@
 # Uguu
 # Uguu
+
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nokonoko_Uguu&metric=alert_status)](https://sonarcloud.io/dashboard?id=nokonoko_Uguu)
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 [![Documentation Status](https://docs.uguu.se/img/flat.svg)](https://docs.uguu.se)
 
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nokonoko_Uguu&metric=alert_status)](https://sonarcloud.io/dashboard?id=nokonoko_Uguu)
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 [![Documentation Status](https://docs.uguu.se/img/flat.svg)](https://docs.uguu.se)
 
-
 # What is Uguu?
 
 Uguu is a simple lightweight temporary file hosting and sharing platform, but can also be used as a permanent file host.
 
 ## Features
 
 # What is Uguu?
 
 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 & Paste supported
-- Upload API with multiple response choices
-  - JSON
-  - HTML
-  - Text
-  - CSV
-- Supports [ShareX](https://getsharex.com/) and other screenshot tools
+- One click uploading, no registration required.
+- A minimal, modern web interface.
+- Drag & Drop & Paste supported.
+- Upload API with multiple response choices:
+    - JSON
+    - HTML
+    - Text
+    - CSV
+- Supports [ShareX](https://getsharex.com/) and other screenshot tools.
+- File extension & MIME black/whitelisting.
+- Upload rate limiting.
+- File (hash) blacklisting.
+- Run bare or as a container.
 
 ### Demo
 
 
 ### Demo
 
@@ -26,16 +30,15 @@ See the real world site at [uguu.se](https://uguu.se).
 
 ## Requirements
 
 
 ## Requirements
 
-Original development environment is Nginx + PHP8.1 + SQLite, but is confirmed to
-work with Apache and older PHP versions like PHP7.4.
+Tested and working with Nginx + PHP-8.1 + SQLite/MySQL.
 
 
-Node is used to compile Uguu.
+Node is used to compile Uguu, after that it runs on PHP.
 
 ## Installation
 
 Installation and configuration can be found at [Uguu Documentation](https://docs.uguu.se).
 
 
 ## Installation
 
 Installation and configuration can be found at [Uguu Documentation](https://docs.uguu.se).
 
-If you need a admin panel check out [Moe Panel](https://github.com/pomf/MoePanel).
+If you need a admin panel check out [Moe Panel](https://github.com/Pomf/MoePanel).
 
 ## Getting help
 
 
 ## Getting help
 
@@ -52,9 +55,16 @@ coding style guides. We use ESLint and PHPCS tools to enforce these standards.
 You can also help by sending us feature requests or writing documentation and
 tests.
 
 You can also help by sending us feature requests or writing documentation and
 tests.
 
+## Upcoming Features
+
+* PostgreSQL Support
+* S3 Bucket Support
+* Azure File Storage Support
+* Temporal/RR Support
+
 ## Credits
 
 ## Credits
 
-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.
+Uguu is based on [Pomf](http://github.com/pomf/pomf) which was written by Emma Lejack & Go Johansson (nekunekus) and with help from the open source community.
 
 ## License
 
 
 ## License