diff --git a/README.md b/README.md index 0b49059..b40fdbf 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,20 @@ # asan.js -**asan.js** is a **convention-over-configuration** model-view system for web-sites and web-applications. +**asan.js** is a **convention-over-configuration** style **model-view** system for web-sites and web-applications. -The attaction of using **asan** is that the location of the **model** for a path is very straight-forward +The attaction of using **asan** is that the location of the **model** for a path is very straight-forward. For example, the **model** for a path "`/an/example/path`" would be at "`/src/an/example/path`". I.e., a "`/src`" prefix is added to the current path to get the **model**. +Since **asan** is **convention-over-configuration**, it takes care of all this for you. +**asan** infers what the current path is. +(Ex: "`/apple/banana/cherry.html`".) +And then **asan** calculates the path of the **model** (based of the current path). +(Ex: "`/src/apple/banana/cherry.html`".) +And then includes that. +You just have to tel it _where_ to include it. + ## Example Here is an example usage of **asan.js**: @@ -19,6 +27,8 @@ Here is an example usage of **asan.js**: