Skip to content

Commit 9a0aaf6

Browse files
authored
readme update (#33)
1 parent 043e19f commit 9a0aaf6

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,21 @@
33
<p align="center"><img width="650" src="./godocx.png" alt="Godocx logo"></p>
44

55

6-
Godocx is a Golang library for creating and modifying DOCX (Microsoft Word) documents.
6+
Godocx is a library written in pure Go providing a set of functions that allow you to write to and read from Docx file.
7+
8+
This library needs Go version 1.18 or later. The full docs can be seen using go's built-in documentation tool, or online at [go.dev](https://pkg.go.dev/github.com/gomutex/godocx). Please refer the [subpackage docx](https://pkg.go.dev/github.com/gomutex/godocx/docx) for the list of functions that can be used.
9+
710

811
## Usage
912
Here's a simple example of how you can use Godocx to create and modify DOCX documents:
1013

14+
## Installation
15+
Use the godocx in your project
16+
```bash
17+
go get github.com/gomutex/godocx
18+
```
19+
20+
1121
### Examples
1222
Explore additional examples and use cases over at GitHub repository dedicated to showcasing the capabilities of Golang Docx:
1323
https://github.com/gomutex/godocx-examples
@@ -81,3 +91,6 @@ This is screenshot of demo document generated from the godocx library.
8191
## Inspiration
8292
The Godocx library is inspired from the python-docx
8393

94+
## Licenses
95+
96+
The Godocx library is licensed under the [MIT License](https://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)