diff options
| author | Juuso Lapinlampi <wub@partyvan.eu> | 2015-10-18 04:55:56 +0200 |
|---|---|---|
| committer | Juuso Lapinlampi <wub@partyvan.eu> | 2015-10-18 04:55:56 +0200 |
| commit | 94c798875ccd64d8ddb9c75b0c8826c814971f5b (patch) | |
| tree | 9981f070564795ee0140e74b27d754248fde8c5a | |
| parent | fffda96d14cbdef5d0b4b1ff611368a216576957 (diff) | |
Add "Features" section to README.md
The README.md lacks a features section, which is worthful for those
searching for a suitable file sharing platform to host.
This change lists the features and seperates "Requirements" to its own
section.
Worthy read: "How to Write a Readme Worth Reading" by Diana Thayer.
https://orchestrate.io/blog/2014/07/16/how-to-write-a-readme-worth-reading/
| -rw-r--r-- | README.md | 16 |
1 files changed, 16 insertions, 0 deletions
@@ -2,6 +2,22 @@ Pomf is a simple file uploading and sharing platform. +## Features + +- One click uploading, no registration required +- A minimal, modern web interface +- Drag & drop supported +- Upload API with multiple response choices + - JSON + - HTML + - Text + - CSV +- Supports [ShareX](https://getsharex.com/) and other screenshot tools + +See the real world example at [Pantsu.cat](https://pantsu.cat/). + +## Requirements + Original development environment is Nginx + PHP5.5 + MySQL, but is confirmed to work with Apache 2.4 and newer PHP versions. Should work with any other PDO-compatible database. |