summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 20 insertions, 15 deletions
diff --git a/README.md b/README.md
index 56cd872..ae782d8 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,11 @@
# Pomf
+Pomf is a simple file uploading and sharing platform.
+
+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.
+
## Install
For the purposes of this guide, we won't cover setting up Nginx, PHP, MySQL,
@@ -12,20 +18,9 @@ The assets are minified and combined using [Grunt](http://gruntjs.com/).
Assuming you already have Node and NPM working, compilation is easy. Use the
following shell code:
-#### Apache
-If you are running Apache and want to compress your output when serving files,
-add to your `.htaccess` file:
-
-```
-AddOutputFilterByType DEFLATE text/html text/plain text/css application/javascript application/x-javascript application/json
-```
-
-Remember to enable `deflate_module` and `filter_module` modules in your Apache
-configuration file.
-
```
npm install -g grunt-cli
-git clone git://github.com/pantsucat/pomf.git
+git clone https://git.pantsu.cat/pantsu/pomf.git
cd pomf/
npm install
grunt
@@ -47,9 +42,20 @@ Make sure to disable PHP from being executed on the file download
domain/directory (e.g a.site.com), otherwise a attacker can upload a malicious
.php file and execute it on your server.
+### Apache
+
+If you are running Apache and want to compress your output when serving files,
+add to your `.htaccess` file:
+
+```
+AddOutputFilterByType DEFLATE text/html text/plain text/css application/javascript application/x-javascript application/json
+```
+
+Remember to enable `deflate_module` and `filter_module` modules in your Apache
+configuration file.
+
## Todo
-* Clean up Moe code, a lot..
* API keys?
## License
@@ -59,5 +65,4 @@ license. See LICENSE.
## Contact
-The maintainer can be contacted via hostmaster@pantsu.cat.
-
+The maintainer can be contacted via <hostmaster@pantsu.cat>.