repos/html-syntax-highlight

highlights code within an html file
Commits Files Refs README LICENSE
commit 7df477930a420b88f932c229aadf1dfa7fcb4493
parent 48d0855746d844215b42eba89c1e46f7f0a121aa
Author: mjkloeckner <martin.cachari@gmail.com>
Date:   Mon,  6 Feb 2023 18:40:13 -0300

Fix README.md

Diffstat:
MREADME.md | 13++++++++-----
1 file changed, 8 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
@@ -6,16 +6,18 @@ code tags. Then you can add chroma themes with css.
 
 ## Running
 
-Make sure you have [golang](https://go.dev/) installed (if not follow this
-[instructions](https://go.dev/doc/install))then run:
+Make sure you have [golang](https://go.dev/) installed (if not, follow [this
+instructions](https://go.dev/doc/install)) then run:
 
 ```shell
 $ go run main.go <test_file.html>
 ```
 
 with `<test_file.html>` being an html file containing some code to highlight.
-This is an example of a code snippet within an html file that this program
-should add css classes
+
+## Input file format
+This is an example of a code snippet contained within an html file that this
+program adds chroma css classes
 
 ```html
 (...)
@@ -32,7 +34,8 @@ int main(void) {
 (...)
 ```
 
-But it uses regular expression so it should be easier to adapt to other formats.
+To capture the code snippet it uses regular expression so it should be easier to
+adapt to other formats.
 
 ## Example
 The main purpose of this program was to highlight code snippets on my blog.