updated documentation, small correction in comments

2022-02-27 07:11:15 +02:00
parent 70256ddf72
commit cb803b8482
3 changed files with 11 additions and 1 deletions
--- a/.gitignore
+++ b/.gitignore
@@ -13,3 +13,8 @@

 # Dependency directories (remove the comment below to include it)
 # vendor/
+/.idea/.gitignore
+/.idea/misc.xml
+/.idea/modules.xml
+/.idea/transcribe.iml
+/.idea/vcs.xml
--- a/codec/README.md
+++ b/codec/README.md
@@ -0,0 +1,4 @@
+# codec
+
+codec is an example and framework for building custom human readable binary 
+transcription encoders.
--- a/codec/codecer/codecer.go
+++ b/codec/codecer/codecer.go
@@ -1,4 +1,5 @@
-// Package codecer is the interface definition for a Human Readable Binary Codec
+// Package codecer is the interface definition for a Human Readable Binary
+// Transcription Codec
 //
 // Interface definitions should be placed in separate packages to
 // implementations so there is no risk of a circular dependency, which is not