aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorIvan Enderlin <ivan.enderlin@hoa-project.net>2012-12-16 16:59:13 +0100
committerIvan Enderlin <ivan.enderlin@hoa-project.net>2012-12-16 16:59:13 +0100
commit7d6159269049145b86cb5aa776c30d53c91f6380 (patch)
tree167495016c88006abf05b8e73ee81c65148e2b3a
parentc817268622bc8a5f1e799e9d73a868a7866359de (diff)
downloadView-7d6159269049145b86cb5aa776c30d53c91f6380.zip
View-7d6159269049145b86cb5aa776c30d53c91f6380.tar.gz
View-7d6159269049145b86cb5aa776c30d53c91f6380.tar.bz2
Add README.md.
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..154439c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+![Hoa](http://static.hoa-project.net/Image/Hoa_small.png)
+
+Hoa is a **modular**, **extensible** and **structured** set of PHP libraries.
+Moreover, Hoa aims at being a bridge between industrial and research worlds.
+
+# Hoa\View
+
+This library defines a view interface: `Hoa\View\Viewable`.
+
+A view is defined by 4 methods:
+
+ * `getOutputStream`: where to write the view;
+ * `getData`: what data we have;
+ * `render`: to run the rendering;
+ * `getRouter`: how do we locate resources and other documents.
+
+That's all.
+
+## Documentation
+
+Different documentations can be found on the website:
+[http://hoa-project.net/](http://hoa-project.net/).
+
+## License
+
+Hoa is under the New BSD License (BSD-3-Clause). Please, see
+[`LICENSE`](http://hoa-project.net/LICENSE).