From 94c798875ccd64d8ddb9c75b0c8826c814971f5b Mon Sep 17 00:00:00 2001 From: Juuso Lapinlampi Date: Sun, 18 Oct 2015 02:55:56 +0000 Subject: 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/ --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 7e1f49b..9e9858a 100644 --- a/README.md +++ b/README.md @@ -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. -- cgit v1.2.3