diff --git a/.gitignore b/.gitignore index 66fd13c..dff6331 100644 --- 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 diff --git a/codec/README.md b/codec/README.md new file mode 100644 index 0000000..51d7e67 --- /dev/null +++ b/codec/README.md @@ -0,0 +1,4 @@ +# codec + +codec is an example and framework for building custom human readable binary +transcription encoders. diff --git a/codec/codecer/codecer.go b/codec/codecer/codecer.go index 299bb97..0bc4478 100644 --- 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