Skip to content

Commit

Permalink
add toc and license
Browse files Browse the repository at this point in the history
  • Loading branch information
lukasjarosch committed Sep 21, 2020
1 parent 3347f41 commit 4734522
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,14 @@
* **Fast**: go-docx is fast since it operates directly on the byte contents instead mapping the XMLs to a custom data struct.
* **Zero dependencies**: go-docx is build with the go stdlib only, no external dependencies.

---

### ➤ Table of Contents
- [Purpose](#-purpose)
- [Getting Started](#-getting-started)
- [How it works](#-how-it-works)
- [License](#-license)

### ➤ Purpose
The task at hand was to replace a set of user-defined placeholders inside a docx document archive with calculated values.
All current implementations in Golang which solve this problem use a naive approach by attempting to `strings.Replace()` the placeholders.
Expand Down Expand Up @@ -160,3 +168,5 @@ All the steps taken in 5. require cumbersome shifting of the offsets. This is th
where the most debugging happened (gosh, so many offsets). The given explanation is definitely enough
to grasp the concept, leaving out the messy bits.

### ➤ License
This software is licensed under the [MIT license](http://opensource.org/licenses/mit-license.php).

0 comments on commit 4734522

Please sign in to comment.