aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWilly Micieli <micieli@laposte.net>2019-08-19 16:44:44 +0200
committerWilly Micieli <micieli@laposte.net>2019-08-19 16:44:44 +0200
commit4cd8847d23e386935d1c51fddbcf9c30158fb196 (patch)
tree116a58e04579bc06c0fcf4d6320d717dd9c7a08d
parent155cece89e0d1d05e2446b6d4521b223d2033559 (diff)
downloadshaolin-4cd8847d23e386935d1c51fddbcf9c30158fb196.zip
shaolin-4cd8847d23e386935d1c51fddbcf9c30158fb196.tar.gz
udpate readmde1.0
-rw-r--r--README.md48
1 files changed, 46 insertions, 2 deletions
diff --git a/README.md b/README.md
index c539bad..c94586b 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,16 @@
+# What it's ?
+
+It's a mvc structure written to be useful for everybody, in order to make websites more simply.
+
+
+# Installation
+
+`composer create-project shaolin/shaolin app_name`
+
+ * [Source code](https://git.fumseck.eu/cgit/shaolin/)
+ * [Bug reports](mailto:bugzilla@laposte.net)
+ * [Download](https://git.fumseck.eu/cgit/shaolin/snapshot/shaolin-1.0.zip)
+
* **Route management**
* Create a new route
* `php shaolin route:add`
@@ -46,9 +59,40 @@
* **Controllers**
* [Available methods](https://git.fumseck.eu/cgit/imperium/tree/imperium/App.php)
* [Available helpers](https://git.fumseck.eu/cgit/imperium/tree/helpers)
-
+ * [Views helpers](https://git.fumseck.eu/cgit/imperium/tree/imperium/View/View.php)
* **helpers**
* Create an admin helper
* Edit the `admin.php` inside the `app/Helpers` directory
* Create a web helper
- * Edit the `web.php` inside the `app/Helpers` directory \ No newline at end of file
+ * Edit the `web.php` inside the `app/Helpers` directory
+
+# Assets
+
+I want to quit bootstrap to design my application.
+
+So i've created sass directory with compass.
+
+You can to be not all right with me so you can use your prefered library.
+
+It's project come like it, but you can use bootstrap.
+
+
+# Model
+
+To call a model use one of it static function and finish by the `all()` method.
+
+All method return an instance expected specific method.
+
+[See model source code](https://git.fumseck.eu/cgit/imperium/tree/imperium/Model/Model.php)
+
+> The users model is used by the authentication
+
+> The paginate callback must be take two arguments the key first and the in second the value
+
+> The value will be an object stdclass so you can use `$value->column` in the callback function
+
+
+# Document root
+
+> Document root must be the web directory
+