1diff --git a/README.md b/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..93f352ca8291e48d5ce41ce545ec94b3314b52bb
 4--- /dev/null
 5+++ b/README.md
 6@@ -0,0 +1,58 @@
 7+# APKDOC
 8+
 9+Document generator for alpine's index format v2 file[^1].
10+
11+## Usage example
12+
13+```sh
14+apkdoc \
15+	-t text \
16+	-u https://alpine.mirror.wearetriple.com/v3.18/main/x86_64/APKINDEX.tar.gz \
17+	-f example.md \
18+	-o index.txt
19+```
20+
21+## Data 
22+
23+`apkdoc` offers a list of the following struct to the template:
24+
25+```go
26+type Entry struct {
27+	Checksum         string     // C
28+	Version          string     // V
29+	Name             string     // P
30+	Architecture     *string    // A
31+	PackageSize      int        // S
32+	InstalledSize    int        // I
33+	Description      string     // T
34+	Url              string     // U
35+	License          string     // L
36+	Origin           *string    // o
37+	Maintainer       *string    // m
38+	BuildTime        *time.Time // t
39+	Commit           *string    // c
40+	ProviderPriority *int       // k
41+	Dependencies     []string   // D
42+	Provides         []string   // p
43+	InstallIf        []string   // i
44+}
45+```
46+
47+## Functions
48+
49+`apkdoc` also offers a couple help functions.
50+
51+### `DerefI`
52+
53+Deref int pointer.
54+
55+### `DerefS`
56+
57+Deref string pointer.
58+
59+### `Properties`
60+
61+A `Entry` function that generate a map of with lower cased space separated
62+property name.
63+
64+[^1]: https://wiki.alpinelinux.org/wiki/Apk_spec
65diff --git a/example.txt b/example.md
66rename from example.txt
67rename to example.md