README Update & Overview

ale8k · Dec 9, 2021 · 2fb2dd8 · 2fb2dd8
1 parent 8d6a4eb
commit 2fb2dd8
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,6 @@
 # Datastructures & Utility functions for GoLang 
+[![Go Reference](https://pkg.go.dev/badge/github.com/ale8k/golang_datastructures_and_algorithms.svg)](https://pkg.go.dev/github.com/ale8k/golang_datastructures_and_algorithms)
+
 A basic GoLang module providing some datastructure implementations and utility functions
 
 ## Resources

diff --git a/golang_datastructures_and_algorithms.go b/golang_datastructures_and_algorithms.go
@@ -0,0 +1,7 @@
+/*
+All structures and algorithms are in subdirectories explicitly named.
+
+Note: I ultimately wanted to understand how go handles it's documentation processing on pkg.go.dev.
+And how it handles versioning in comparison to other tools like maven, npm, pip etc.
+*/
+package golangdatastructuresandalgorithms