diff --git a/README.md b/README.md new file mode 100644 index 0000000..fffd9bf --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# Free Super Clean PHP File Directory Listing Script + +Easily display files and folders in a mobile friendly, clean and cool way. Just drop the `index.php` in your folder and you are ready to go. + +## Options + +At the top of the `index.php` file you have a few settings you can change: + +-- +`$title = "List of Files";` + +This will be the title of your page and also is set to the meta mitle of the document. + +-- +`$ignore_file_list = array( ".htaccess", "Thumbs.db", ".DS_Store", "index.php" );` + +Create an array of files that you do not want to appear in the listing + +-- +`$ignore_ext_list = array( );` + +You can create an array of extensions not to show, for example: 'jpg,png,gif,pdf' + +-- +`$sort_by = "name_asc";` + +This will sort the files, the available options are: name_asc, name_desc, date_asc, date_desc + +-- +`$icon_url = "https://dl.dropbox.com/u/6771946/icons/flat.png";` + +The URL of the icons used on the left. This is sprite of even spaced out icons. You can create your own like the one above and just change this link. + +-- +`$toggle_sub_folders = true;` + +If a folder is clicked on, it will slide down the sub folder. You can turn this off here.