Add note as to what this does

[civicrm-core.git] / ext / afform / README.md

diff --git a/ext/afform/README.md b/ext/afform/README.md
index bbe9cb53c47b117a10b1b02f348b6a0c382ed233..1731e8e77be102e8366b1f4728771b92880ca9fe 100644 (file)
--- a/ext/afform/README.md
+++ b/ext/afform/README.md
@@ -1,14 +1,19 @@
 # org.civicrm.afform (Early Proof of Concept)
 
-![Screenshot](/images/screenshot.png)
+> You are looking at the `master` branch of a proof-of-concept module.  It
+> may change radically (without full curation of docs, etc).  For previous
+> iterations with more stable/cogent materials, check other branches (e.g.
+> `0.1`).
+
+![Screenshot](docs/sandbox/3-Free-Blocks-Parent.png)
 
 The Affable Administrative Angular Form Framework (`afform`) is a system for administering AngularJS-based forms
 in CiviCRM which:
 
 1. Allows developers to declaratively define a canonical, baseline form using AngularJS.
-2. Allows administrators (or administrative tools) to use the CRUD API to customize the forms.
+2. Allows administrators (or administrative GUI tools) to use the CRUD API to customize the forms.
 3. Allows developers (or administrators/tools) to embed these forms in other CiviCRM-AngularJS apps.
-4. (WIP; pending upstream support) Allow developers to apply [change sets](https://docs.civicrm.org/dev/en/latest/framework/angular/changeset/).
+4. Allows developers to apply change-sets via hook. (*WIP; pending upstream support*)
 
 This extension is a proof-of-concept.  It aims to demonstrate the core model/concept -- however, there are 
 [known issues and additional components](docs/roadmap.md) to address, and some documentation will be easier to approach
@@ -16,9 +21,10 @@ if you already have a basic understanding of CiviCRM API and AngularJS.  It is l
 
 ## Requirements
 
-* PHP v5.4+
-* CiviCRM v5.3+
+* PHP v5.6+
+* CiviCRM v5.7+
 
+<!--
 ## Installation (Web UI)
 
 This extension has not yet been published for installation via the web UI.
@@ -32,6 +38,7 @@ install it with the command-line tool [cv](https://github.com/civicrm/cv).
 cd <extension-dir>
 cv dl org.civicrm.afform@https://github.com/totten/afform/archive/master.zip
 ```
+-->
 
 ## Installation (CLI, Git)
 
@@ -49,5 +56,7 @@ cv en afform
 * [Writing Forms: Afform as basic AngularJS templates](docs/writing.md) (With example: *Contact Record*)
 * [Embedding Forms: Afform as reusable building-block](docs/embed.md) (With example: *Contact Record*)
 * [Form CRUD: Updating forms via programmatic API](docs/crud.md)
+* [Form Hooks: Updating forms via declarative selector](docs/alter.md) (*WIP; pending upstream support*)
 * [Full AngularJS: Integrating between Afform and vanilla AngularJS](docs/angular.md)
 * [Roadmap and Known Issues](docs/roadmap.md)
+* [Philosophy, Beliefs, Assumptions](docs/philosophy.md)