all: update README for kilabit.info/project/asciidoctor-go

1 files changed, 45 insertions, 37 deletions

diff --git a/README.md b/README.md
index d79a5f6..d7132d5 100644
--- a/README.md
+++ b/README.md
@@ -8,25 +8,27 @@ For the front-end tooling that use this library to build static website
 see
 [ciigo](https://sr.ht/~shulhan/ciigo).
 
-##  Documentation
 
-[Go documentation](https://pkg.go.dev/git.sr.ht/~shulhan/asciidoctor-go).
+##  Documentation
 
-### Specifications
+See the
+[Go module documentation](https://pkg.go.dev/git.sr.ht/~shulhan/asciidoctor-go)
+for the API and examples on how to use this library to parse and render
+Asciidoc file.
 
 During reverse engineering the AsciiDoc markup, we write the syntax, rules,
 and format in
-[SPECS](SPECS.html).
+[specification file](SPECS.html).
+
 
-### Features
+## Features
 
 List of available formatting that are supported on current implementation.
 Each supported feature is linked to official
 [AsciiDoc Language Documentation](https://docs.asciidoctor.org/asciidoc/latest)
-The numbered one is based on the old documentation.
 
 * [Document header](https://docs.asciidoctor.org/asciidoc/latest/document/header/)
-  * [Document title](https://docs.asciidoctor.org/asciidoc/latest/document/header/document/title/).
+  * [Document title](https://docs.asciidoctor.org/asciidoc/latest/document/title/).
     This including meta `doctitle`, `showtitle!` and subtitle.
   * [Author information](https://docs.asciidoctor.org/asciidoc/latest/document/author-information/)
   * [Revision information](https://docs.asciidoctor.org/asciidoc/latest/document/revision-information/)
@@ -83,7 +85,6 @@ The numbered one is based on the old documentation.
   * Table borders
   * Striping
   * Orientation
-  * ~~Nested tables~~
   * Table caption
   * Escaping the Cell Separator
 * Horizontal Rules
@@ -156,21 +157,22 @@ Additional document attribute provides by this library,
 
 * `author_names` - list of author full names separated by comma.
 
-###  Notes
 
-#### Unsupported markup
+##  Notes
 
-The following markup will not supported because its functionality is duplicate
-or inconsistent with others markup, or not secure,
+### Unsupported markup
+
+The following markup will not supported either because its functionality is
+duplicate, or inconsistent with others markup, or not secure,
 
 * Header
   * Subtitle partitioning.
-    Rationale: duplicate with 14.1.2 the "Main: sub" format
+    Rationale: duplicate with the "Main: sub" format
 
 * Tables
   * Nested tables.
-    Rationale: nested table is not a good way to present information.
-    Never should it be.
+    Rationale: nested table is not a good way to present information,
+    never should it be.
   * Using different cell separator
 
 * Includes
@@ -181,7 +183,7 @@ or inconsistent with others markup, or not secure,
     Rationale: security and unreliable network connections.
 
 
-####  Unordered list item with hyphen
+###  Unordered list item with hyphen
 
 The unordered list item with hyphen ('-') cause too much confusion and
 inconsistency.
@@ -209,7 +211,8 @@ simple list item
 > because the hyphen marker (-) doesn’t work for nested lists.
 > -- <https://docs.asciidoctor.org/asciidoc/latest/lists/unordered/#basic-unordered-list>
 
-###  TODO
+
+##  TODO
 
 List of features which may be implemented,
 
@@ -238,35 +241,22 @@ List of features which may be implemented,
   * Passthrough Macros
 
 
-####  Bugs
-
-Unknown.
-If you found one, please report it
-[here](https://todo.sr.ht/~shulhan/asciidoctor-go).
+Future enhancements,
 
-
-####  Enhancements
-
-Create tree that link Include directive.
+(1) Create tree that link Include directive.
 Once the included files changes, the parent should be re-converted too.
 
-```
-Include Node
-parent -> Parent Node.
-```
-
-###  Miscellaneous
 
-The following files compare the HTML generated by asciidoctor and this
-library:
+##  Bugs
 
-* [HTML file generated using asciidoctor](testdata/test.exp.html)
-* [HTML file using this library](testdata/test.got.html)
+Unknown.
+If you found one, please report it
+[here](https://todo.sr.ht/~shulhan/asciidoctor-go).
 
 
 ## Development
 
-[Changelog](CHANGELOG.html)::
+[Changelog](https://kilabit.info/project/asciidoctor-go/CHANGELOG.html)::
 List of each releases and their changes.
 
 [Repository](https://git.sr.ht/~shulhan/asciidoctor-go)::
@@ -277,3 +267,21 @@ Link to discussion or where to send the patches.
 
 [Issues](https://todo.sr.ht/~shulhan/asciidoctor-go)::
 Link to open an issue or request for new feature.
+
+
+## License
+
+Copyright (C) 2021 Shulhan [&lt;ms@kilabit.info&gt;](mailto:ms@kilabit.info)
+
+This program is free software: you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the Free
+Software Foundation, either version 3 of the License, or (at your option)
+any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+more details.
+
+You should have received a copy of the GNU General Public License along with
+this program.  If not, see <http://www.gnu.org/licenses/>.