summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 17 insertions, 9 deletions
diff --git a/README.md b/README.md
index 8e7a43c..23e1b75 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,30 @@
# x-anom
(another MVC framework)
+An open-source, fast, super-light, secure, full-featured, modern, easy to setup, easy to learn,
+highly extendable, php 8+, OOP MVC framework for the php-developer.
-## pre-Check
-
-Update ```~./container/config/composer-copy.json``` according to
-```~./composer.json``` or vice-versa. You actualy need just one of them;
-if pulling the project into a server (bare-metar/vps/shared etc) you only
-need the first; if pulling into container you need the second/
+## pre-Check
-On a Linux system you can also create a link from the one file to the other
-(then you need to use ralative paths on autoload.classmap section).
-
+(1)
+There are several ```composer*.json``` versions;
+the ```~./composer.json``` is the only one you actually need;
+all others found under ```~./docker/config/composer-*,json``` are for testing/
+case-study puproses; so make sure that ```~./composer.json``` is updated with
+all required packages
+
+(2)
When deploying on PRODUCTION make sure that all development routes are deleted
and debuging messages are disabled.
+(3)
+Anom 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
+Make sure to keep the one that suits your needs (or both if needed);