doc: update readme.

ghosind · Jun 4, 2023 · ce032c3 · ce032c3
1 parent 0096847
commit ce032c3
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -22,6 +22,10 @@ This package provides the following data structure interfaces and implementation
 
     - [`ConcurrentHashSet`](https://pkg.go.dev/github.com/ghosind/collection#ConcurrentHashSet): The thread safe implementation of Set based on Go built-in map structure.
 
+- `Map`: A object that maps keys to values, and it cannot contain duplicate key.
+
+    - [`HashMap`](https://pkg.go.dev/github.com/ghosind/collection#HashMap): The implementation of Map based on Go built-in map structure.
+
 ## Installation
 
 You can install this package by the following command.

diff --git a/map.go b/map.go
@@ -1,5 +1,6 @@
 package collection
 
+// Map is a object that maps keys to values, and it cannot contain duplicate key.
 type Map[K comparable, V any] interface {
 	// Clear removes all key-value pairs in this map.
 	Clear()