[feat] Insertion of Gopher specific content and ommition of web-only content

README.md

@@ -0,0 +1,77 @@
+
+### Compiling
+
+This program compiles like any other ordinary Go project, simply **run** `go build .` in the project directory.
+
+### Usage
+```shell
+gemtext2gophermap input.gmi output_gophermap [max line length (default 70)] [preprocessor insertion map file]
+```
+
+## Example
+
+### Input Gemtext
+_input.gmi_
+````gemtext
+Everything until the first <!--break--> in the map file will be put in place of the insert-gopher tag.
+
+```html
+<!--insert-gopher-->
+```
+
+The following <script> tag will be removed because it is between to web-only tags.
+
+```html
+<!--web-only-->
+```
+
+```html
+<script>
+console.log("joj")
+</script>
+```
+
+```html
+<!--web-only-->
+```
+
+> Here, the contents after the first break in the map file will be put
+
+```html
+<!--insert-gopher-->
+```
+````
+
+### A map file
+_map.txt_
+```gophermap
+<?php
+echo "i" . date(DATE_RFC2822) . "\t/FAKE\tNULL\t0";
+?>
+<!--break-->
+iIf your Gopher server supports running PHP it should have printed the current date.	/FAKE	NULL	0
+```
+
+### Command
+```shell
+gemtext2gophermap input.gmi - 70 map.txt
+```
+If `-` is passed instead of `input/output` file name `stdin/stdout` will be used. Reading the **map file from stdin** is **not supported**.
+
+### Output
+```gophermap
+iEverything until the first <!--break--> in the map file will be put in /FAKE   NULL    0
+iplace of the insert-gopher tag.        /FAKE   NULL    0
+
+<?php
+echo "i" . date(DATE_RFC2822) . "\t/FAKE\tNULL\t0";
+?>
+
+iThe following <script> tag will be removed because it is between to    /FAKE   NULL    0
+iweb-only tags. /FAKE   NULL    0
+
+i> Here, the contents after the first break in the map file will be put /FAKE   NULL    0
+
+
+iIf your Gopher server supports running PHP it should have printed the current date.    /FAKE   NULL    0
+```