From 89a281434c87f879c8f4b8dd280c7f1886316067 Mon Sep 17 00:00:00 2001
From: NorthCityChen <449293786@qq.com>
Date: Sat, 2 Apr 2022 14:30:40 +0800
Subject: [PATCH] ADD: readme

---
 readme.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 51 insertions(+), 1 deletion(-)

diff --git a/readme.md b/readme.md
index 61db93f..02ec5ca 100644
--- a/readme.md
+++ b/readme.md
@@ -1,6 +1,6 @@
 <!--
  * @Author: NorthCity1984
- * @LastEditTime: 2022-04-02 14:23:56
+ * @LastEditTime: 2022-04-02 14:30:28
  * @Description: 
  * @Website: https://grimoire.cn
  * Copyright (c) NorthCity1984 All rights reserved.
@@ -9,6 +9,56 @@
 
 一个封装了一些简单的数据结构的提供泛型支持的stl库 (go >= 1.18)
 
+# usage
+
+## Dequeue
+
+```go
+package main
+
+import (
+	"fmt"
+
+	"gitee.com/NorthCityChen/stl-go/dequeue"
+)
+
+func main() {
+	q := dequeue.Init[int]()
+	q.LPush(12)
+	q.LPush(23)
+	q.LPush(34)
+	q.Clear()
+	q.LPush(34)
+	q.RPush(44)
+	fmt.Println(q.LPop())
+	fmt.Println(q.LPop())
+	fmt.Println(q.LPop())
+	fmt.Println(q.LPop())
+}
+```
+
+## Queue
+
+```go
+import (
+	"fmt"
+
+	"gitee.com/NorthCityChen/stl-go/queue"
+)
+
+func main() {
+	q := queue.Init[int]()
+	q.Push(12)
+	q.Push(23)
+	q.Push(44)
+	fmt.Println(q.Pop())
+	fmt.Println(q.Pop())
+	fmt.Println(q.Pop())
+	fmt.Println(q.Pop())
+}
+
+```
+
 # RoadMap
 
 - [x] 双端队列