README.md + CHANGELOG.md: More updates.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
diff --git a/CHANGELOG.md b/CHANGELOG.md
index e3b68e5..1c7ad05 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -14,6 +14,8 @@ New features:
* [ ] baz
```
+ (It has to be explicitly enabled with `MD_FLAG_TASKLISTS`.)
+
* Renamed structure `MD_RENDERER` to `MD_PARSER` and refactorize its contents
a little bit. Note this is source-level incompatible and initialization code
in apps may need to be updated.
@@ -30,14 +32,18 @@ New features:
Fixes:
- * CID 1475544: Calling `md_free_attribute()` on uninitialized data.
+ * CID 1475544:
+ Calling `md_free_attribute()` on uninitialized data.
- * #47: Using bad offsets in `md_is_entity_str()`, in some cases leading to
- buffer overflow.
+ * [#47](https://github.com/mity/md4c/issues/47):
+ Using bad offsets in `md_is_entity_str()`, in some cases leading to buffer
+ overflow.
- * #51: Segfault in `md_process_table_cell()`.
+ * [#51](https://github.com/mity/md4c/issues/51):
+ Segfault in `md_process_table_cell()`.
- * #53: With `MD_FLAG_PERMISSIVEURLAUTOLINKS` or `MD_FLAG_PERMISSIVEWWWAUTOLINKS`
+ * [#53](https://github.com/mity/md4c/issues/53):
+ With `MD_FLAG_PERMISSIVEURLAUTOLINKS` or `MD_FLAG_PERMISSIVEWWWAUTOLINKS`
we could generate bad output for ordinary Markdown links, if a non-space
character immediately follows like e.g. in `[link](http://github.com)X`.
diff --git a/README.md b/README.md
index 0740ca6..4185c93 100644
--- a/README.md
+++ b/README.md
@@ -55,19 +55,21 @@ MD4C is C Markdown parser with the following features:
## Using MD4C
-The parser is implemented in a single C source file `md4c.c` and its
-accompanying header `md4c.h`.
+Application has to include the header `md4c.h` and link against MD4C library;
+or alternatively it may include `md4c.h` and `md4c.c` directly into its source
+base as the parser is only implemented in the single C source file.
The main provided function is `md_parse()`. It takes a text in Markdown syntax
-as an input and a pointer to renderer structure which holds pointers to few
+as an input and a pointer to a structure which holds pointers to several
callback functions.
-As `md_parse()` processes the input, it calls the appropriate callbacks
-allowing application to convert it into another format or render it onto
-the screen.
+As `md_parse()` processes the input, and it calls the appropriate callbacks
+(when entering or leaving any Markdown block or span; and when outputting any
+textual content of the document), allowing application to convert it into
+another format or render it onto the screen.
More comprehensive guide can be found in the header `md4c.h` and also
-on [MD4C wiki](http://github.com/mity/md4c/wiki).
+on [MD4C wiki].
Example implementation of simple renderer is available in the `md2html`
directory which implements a conversion utility from Markdown to HTML.
@@ -99,6 +101,8 @@ extensions:
* With the flag `MD_FLAG_PERMISSIVEWWWAUTOLINKS` permissive WWW autolinks
(without any scheme specified; `http:` is assumed) are supported.
+The syntax of the extensions is described on [MD4C wiki].
+
Few features (those some people see as mis-features) of CommonMark
specification may be disabled:
@@ -168,3 +172,7 @@ If you encounter any bug, please be so kind and report it. Unheard bugs cannot
get fixed. You can submit bug reports here:
* http://github.com/mity/md4c/issues
+
+
+[MD4C home]: http://github.com/mity/md4c
+[MD4C wiki]: http://github.com/mity/md4c/wiki