Browse Source

docs: updated running information

Nikola Kotur 9 years ago
parent
commit
bc70abed40
1 changed files with 12 additions and 4 deletions
  1. 12 4
      README.md

+ 12 - 4
README.md

@@ -1,18 +1,26 @@
 Phosic
 ======
 
-Simple web service to join mp3 file and a picture.
+Simple web service to join mp3 file and a picture using Flask, ffmpeg, Celery,
+SQLite and Redis.
 
 How to run it?
 --------------
 
-In development mode, first create the database:
+In development mode, create virtual environment and install `requirements.txt`
+with pip, and then create the database:
 
     ./db_create.py
     ./db_upgrade.py
 
-Then use the script in `bin` folder to run it:
+After that just use the script in `bin` folder to run it:
 
     ./bin/run.sh
 
-After that you can access the website at http://localhost:8000
+Now you can access the website at http://localhost:8000
+
+Production
+----------
+
+To run phosic in production see `conf` directory for nginx configuration and
+supervisord units.