Merge pull request #2 from essentialkaos/develop

Improvements
essentialkaos · Jan 4, 2023 · 40dccba · 40dccba
2 parents 356c21c + 0ba3f35
commit 40dccba
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -2,7 +2,6 @@
 
 <p align="center">
   <a href="https://kaos.sh/g/npck"><img src="https://gh.kaos.st/godoc.svg" alt="PkgGoDev" /></a>
-  <a href="https://kaos.sh/r/npck"><img src="https://kaos.sh/r/npck.svg" alt="GoReportCard" /></a>
   <a href="https://kaos.sh/w/npck/ci"><img src="https://kaos.sh/w/npck/ci.svg" alt="GitHub Actions CI Status" /></a>
   <a href="https://kaos.sh/w/npck/codeql"><img src="https://kaos.sh/w/npck/codeql.svg" alt="GitHub Actions CodeQL Status" /></a>
   <a href="https://kaos.sh/c/npck"><img src="https://kaos.sh/c/npck.svg" alt="Coverage Status" /></a>

diff --git a/npck.go b/npck.go
@@ -0,0 +1,26 @@
+package npck
+
+// ////////////////////////////////////////////////////////////////////////////////// //
+//                                                                                    //
+//                         Copyright (c) 2023 ESSENTIAL KAOS                          //
+//      Apache License, Version 2.0 <https://www.apache.org/licenses/LICENSE-2.0>     //
+//                                                                                    //
+// ////////////////////////////////////////////////////////////////////////////////// //
+
+import (
+	"github.com/essentialkaos/npck/tar"
+	"github.com/essentialkaos/npck/tbz"
+	"github.com/essentialkaos/npck/tgz"
+	"github.com/essentialkaos/npck/txz"
+	"github.com/essentialkaos/npck/tzst"
+)
+
+// ////////////////////////////////////////////////////////////////////////////////// //
+
+func stub() {
+	tar.Unpack("", "")
+	tbz.Unpack("", "")
+	tgz.Unpack("", "")
+	txz.Unpack("", "")
+	tzst.Unpack("", "")
+}
diff --git a/tar/tar.go b/tar/tar.go
@@ -1,3 +1,4 @@
+// Package tar provides method for unpacking tar files
 package tar
 
 // ////////////////////////////////////////////////////////////////////////////////// //

diff --git a/tbz/tbz.go b/tbz/tbz.go
@@ -1,3 +1,4 @@
+// Package tbz provides method for unpacking tar.bz2 files
 package tbz
 
 // ////////////////////////////////////////////////////////////////////////////////// //

diff --git a/tgz/tgz.go b/tgz/tgz.go
@@ -1,3 +1,4 @@
+// Package tgz provides method for unpacking tar.gz files
 package tgz
 
 // ////////////////////////////////////////////////////////////////////////////////// //

diff --git a/txz/txz.go b/txz/txz.go
@@ -1,3 +1,4 @@
+// Package txz provides method for unpacking tar.xz files
 package txz
 
 // ////////////////////////////////////////////////////////////////////////////////// //

diff --git a/tzst/tzst.go b/tzst/tzst.go
@@ -1,3 +1,4 @@
+// Package tzst provides method for unpacking tar.zst files
 package tzst
 
 // ////////////////////////////////////////////////////////////////////////////////// //