summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 34 insertions, 1 deletions
diff --git a/README.md b/README.md
index 23e1b75..ee9a742 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,36 @@ highly extendable, php 8+, OOP MVC framework for the php-developer.
+## why anom?
+
+* fast and secure
+* modern, super light and elegant
+* easy to setup, to learn, to optimize
+* extendable + TODO: scalable
+* ready for any server environment (metal, VM, container)
+
+
+
+## requirements
+
+* php 8.1+
+* web server
+* latest MySQL or MariaDB
+
+
+
+## installation
+
+* download, unzip, crete virtual-host, restart web-server
+* composer based, setup, run
+* docker based
+
+
+
+##
+
+
+
## pre-Check
(1)
@@ -20,7 +50,7 @@ When deploying on PRODUCTION make sure that all development routes are deleted
and debuging messages are disabled.
(3)
-Anom sets-up two writable folders:
+Anom pre-sets-up two writable folders:
* ```~/storage``` (pre-public directory) ideal for file-sessioning, file-caching;
also ideal for file-uploading when serve permition is needed;
* ```~/public/files``` (post-public folder) which is ideal for public access content
@@ -155,6 +185,9 @@ To host the Memcached service:
2. Onto Dockerfile: uncomment the lines under subsection 'Install Memcached'
+* TODO:
+[set web ports and other options witn an .env file](https://stackoverflow.com/questions/52664673/how-to-get-port-of-docker-compose-from-env-file)
+
* TODO: Maria database