From b6db20b26a4ec0dd460ee1cfd4ea017e6f5c5a33 Mon Sep 17 00:00:00 2001 From: Marco Dickert Date: Fri, 17 Feb 2017 11:14:42 +0100 Subject: [PATCH] Updated readme.md after new release --- README.md | 45 ++++++++++++++++++++++----------------------- 1 file changed, 22 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 964e07d..a3b0d41 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,30 @@ # IFM - improved file manager +## about This is a simple filemanager. It is a single file solution which uses HTML5, CSS3, JavaScript and PHP. It works like a client-server system where HTML5/CSS3/JavaScript is the client part and the PHP API acts as the server, which reduces the traffic significant. -The IFM comes with a embedded Version of [jQuery](http://jquery.com) and [ACE Editor](http://ace.c9.io). -## requirements -Client - * HTML5 and CSS3 compatible browser - * activated JavaScript - -Server - * >= PHP 5.5 (only if using auth; if not PHP 5.4 works either) - * optional: cURL extention (for remote upload) - -## issues -Currently there are no known issues. - -## screenshot -![IFM screenshot 1](https://misterunknown.de/static/ifm-screenshot-1.png "IFM screenshot") -![IFM screenshot 2](https://misterunknown.de/static/ifm-screenshot-2.png "IFM screenshot") +The IFM uses the following resources: +* [ACE Editor](https://ace.c9.io) +* [Bootstrap v3](https://getbootstrap.com) +* [jQuery](https://jquery.com) +* custom icon set generated with [Fontello](http://fontello.com/) ## installation -Just copy this ifm.php to your webspace - thats all :) +Just copy the ifm.php to your webspace - thats all :) + +## requirements +| Client | Server | +|:--------------------------------- |:------------------------------------------------------------ | +| HTML5 and CSS3 compatible browser | PHP >= 5.5 (only if using auth; if not PHP 5.4 works either) | +| activated JavaScript | optional: cURL extention (for remote upload) | + +## issues +Currently there are no known issues. If you find any flaws please let me know. + +## screenshots + + + + ## configuration The configuration is located at the top of the script in a separate configuration class. The options in the class are commented and named laconically. If you have questions anyway [write me an email](mailto:marco@misterunknown.de). @@ -40,13 +45,7 @@ The file should contain ONLY ONE LINE: ``` The password hash has to be a hash generated by PHPs `password_hash()` function. The default credentials are "admin:admin". - ## security information The IFM was developed with the assumption that the highest level of operation is the scripts base location. So it is neither possible to nagivate nor to use any API function in a level above the script root. It is highly recommended to restrict access to the script e.g. using a basic authentication. - -## references -I used some nice free icons in my script which I want to mention here: - * file icons: [Free file icons by Teambox](https://github.com/teambox/Free-file-icons) - * other icons: [Mono icons from tutorial9.net](http://www.tutorial9.net/downloads/108-mono-icons-huge-set-of-minimal-icons/)