Beautify README
[erdiag.git] / README.md
index b39f8a7..4806b37 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,7 +5,11 @@ Inspired by [this repository](https://code.google.com/archive/p/merisier/).
 This parser reads ER diagrams definition files, and produces two types of diagrams + SQL code.
 [Graphviz](https://www.graphviz.org/) is used on server side to translate parsed graph descriptions into SVG objects.
 
-*TODO list:* functional integrity constraints (CIF), inter-relations constraints (or, and, xor...), inheritance with the right symbol (triangle).
+**TODO** list:
+
+ - functional integrity constraints (CIF),
+ - inter-relations constraints (or, and, xor...),
+ - inheritance with the right symbol (triangle).
 
 *Note:* temporary dependency to [underscore](http://underscorejs.org/); good library but used so far only for its shuffle() method.
 
@@ -54,7 +58,7 @@ To indicate an inheritance relation, proceed as follow
        Animal Cat Fish
        Planet Mars Venus
 
-Finally, blocks must be separated by new lines. For a usage example, see example.html (it should render as seen in example.svg)
+Finally, blocks must be separated by new lines. For a usage example, see example.html (it should render as seen in example\_\*.svg)
 
 Note that the "drawMcd" method can take a second argument, which indicates the type of graph.
  * "bubble" draws the standard graph, as seen [here](https://en.wikipedia.org/wiki/Entity%E2%80%93relationship_model#/media/File:ER_Diagram_MMORPG.png) for example