Improved documentation. (#5)

qqiao · May 2, 2022 · 0af9c5e · 0af9c5e
1 parent 385488a
commit 0af9c5e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 # buildinfo
 
-Buildinfo is a library that provides an easy solution to embed build information into any applications.
+Buildinfo is a library that provides an easy solution to embed build
+information into applications.
 
 ### Installation
 
@@ -11,4 +12,6 @@ The `buildinfo` package is a go module, so simply using:
 in your application's go module should make it available.
 
 ### Usage
-Please refer to [source code documentation](https://pkg.go.dev/github.com/qqiao/buildinfo) for usage examples.
+
+Please refer to [source code documentation](https://pkg.go.dev/github.com/qqiao/buildinfo)
+for API documentation and examples.
diff --git a/doc.go b/doc.go
@@ -15,7 +15,7 @@
 /*
 
 Package buildinfo contains helper functions to help embed build information
-into an application.
+into applications.
 
 */
 package buildinfo