README.md - Fill in some FIXME's
authorTim Otten <totten@civicrm.org>
Wed, 13 Jun 2018 03:44:02 +0000 (20:44 -0700)
committerCiviCRM <info@civicrm.org>
Wed, 16 Sep 2020 02:13:16 +0000 (19:13 -0700)
ext/afform/README.md

index 9ddd4b3b2af51f2e2279e94d2f5c14b5bca784c6..81afea183263e6ed6af0d992679747dbf5b5e46f 100644 (file)
@@ -2,14 +2,18 @@
 
 ![Screenshot](/images/screenshot.png)
 
-(*FIXME: In one or two paragraphs, describe what the extension does and why one would download it. *)
+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.
+2. Allows administrators (or administrative tools) to use the API to revise the forms.
 
 The extension is licensed under [AGPL-3.0](LICENSE.txt).
 
 ## Requirements
 
 * PHP v5.4+
-* CiviCRM (*FIXME: Version number*)
+* CiviCRM v5.3+
 
 ## Installation (Web UI)
 
@@ -103,4 +107,7 @@ customizable `foobar` form as part of your UI.  Fortunately, `foobar` is availab
 
 ## Known Issues
 
-(* FIXME *)
+* The code is currently written as a proof-of-concept. There are several `FIXME`/`TODO` declarations in the code
+  for checking pre-conditions, reporting errors, handling edge-cases, etc.
+* Although afforms are can be used in AngularJS, they don't fully support tooling like `cv ang:html:list`
+  and `hook_civicrm_alterAngular`. We'll need a core patch to allow that.