X-Git-Url: https://jfr.im/git/uguu.git/blobdiff_plain/853b768036607f56e7d8fded94d83923df8ae053..b318cf67eb590625259068eeaafddb25de7881de:/README.md

diff --git a/README.md b/README.md
index d9ae401..4f08d89 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-# Uguu
+# What is Uguu?
 
-Uguu is a simple temporary file uploading and sharing platform where files get deleted after 24 hours.
+Uguu is a simple lightweight temporary file uploading and sharing platform where files get deleted after X amount of time.
 
 ## Features
 
@@ -20,104 +20,35 @@ See the real world example at [uguu.se](https://uguu.se).
 
 ## Requirements
 
-Original development environment is Nginx + PHP7.3 + SQLite, but is confirmed to
-work with Apache 2.4 and newer PHP versions.
+Original development environment is Nginx + PHP5.3 + SQLite, but is confirmed to
+work with Apache 2.4 and newer PHP versions like PHP7.3.
 
 ## Install
 
-For the purposes of this guide, we won't cover setting up Nginx, PHP, SQLite,
-Node, or NPM. So we'll just assume you already have them all running well.
+A detailed installation and configuration can be found at [Uguu/Pomf Documentation](https://blog.yeet.nu/blog/uguu-docs).
 
-### Compiling
-
-First you must get a copy of the uguu code.  To do so, clone this git repo.
-```bash
-git clone https://github.com/nokonoko/uguu
+## API
+To upload using curl or make a tool you can post using: 
 ```
-
-Assuming you already have Node and NPM working, compilation is easy.
-
-Run the following commands to do so, please configure `dist.json` before you compile.
-```bash
-cd uguu/
-make
-make install
+curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php (JSON Response)
 ```
-OR
-```bash
-make install DESTDIR=/desired/path/for/site
 ```
-After this, the uguu site is now compressed and set up inside `dist/`, or, if specified, `DESTDIR`.
-
-## Configuring
-
-Front-end related settings, such as the name of the site, and maximum allowable
-file size, are found in `dist.json`.  Changes made here will
-only take effect after rebuilding the site pages.  This may be done by running
-`make` from the root of the site directory.
-
-Back-end related settings, such as database configuration, and path for uploaded files, are found in `static/php/includes/settings.inc.php`.  Changes made here take effect immediately.
-
-If you intend to allow uploading files larger than 2 MB, you may also need to
-increase POST size limits in `php.ini` and webserver configuration. For PHP,
-modify `upload_max_filesize` and `post_max_size` values. The configuration
-option for nginx webserver is `client_max_body_size`.
-
-Edit checkdb.sh and checkfiles.sh to the proper paths:
-```bash
-sqlite3 /path/to/db/uguu.sq3 "DELETE FROM files WHERE date <= strftime('%s', datetime('now', '-1 day'));"
+curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=text (Text Response)
 ```
-```bash
-find /path/to/files/ -mmin +1440 -exec rm -f {} \;
 ```
-Then add them to your crontab:
-```bash
-0,30 * * * * bash /path/to/checkfiles.sh
-0,30 * * * * bash /path/to/checkdb.sh
+curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=csv (CSV Response)
 ```
-
-These scripts check if DB entries and files are older then 24 hours and if they are deletes them.
-
-## Using SQLite as DB engine
-
-We need to create the SQLite database before it may be used by uguu.
-Fortunately, this is incredibly simple.  
-
-First create a directory for the database, e.g. `mkdir /var/db/uguu`.  
-Then, create a new SQLite database from the schema, e.g. `sqlite3 /var/db/uguu/uguu.sq3 -init /home/uguu/sqlite_schema.sql`.
-Then, finally, ensure the permissions are correct, e.g.
-```bash
-chown www-data:www-data /var/db/uguu
-chmod 0750 /var/db/uguu
-chmod 0640 /var/db/uguu/uguu.sq3
 ```
-
-Finally, edit `php/includes/settings.inc.php` to indicate this is the database engine you would like to use.  Make the changes outlined below
-```php
-define('UGUU_DB_CONN', '[stuff]'); ---> define('UGUU_DB_CONN', 'sqlite:/var/db/uguu/uguu.sq3');
-define('UGUU_DB_USER', '[stuff]'); ---> define('UGUU_DB_USER', null);
-define('UGUU_DB_PASS', '[stuff]'); ---> define('UGUU_DB_PASS', null);
+curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=html (HTML Response)
 ```
 
-*NOTE: The directory where the SQLite database is stored, must be writable by the web server user*
-
-### 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.
-
 ## Getting help
 
 Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se
 
 ## Credits
 
-Uguu is based off [Pomf](http://github.com/pomf/pomf).
+Uguu is based on [Pomf](http://github.com/pomf/pomf) which was written by Emma Lejack & Eric Johansson (nekunekus).
 
 ## License