From 8b5ad7c432c3a333d19d2e7ed49b31216ae5cbd7 Mon Sep 17 00:00:00 2001
From: hz <hedzrz@gmail.com>
Date: Fri, 8 Apr 2022 10:04:47 +0800
Subject: [PATCH] bump to v2

---
 README.md | 60 +++++++++++++++++++++++++++++++++++++------------------
 1 file changed, 41 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index 47f6612..94db4df 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# go-ringbuf
+# go-ringbuf [V2]
 
 ![Go](https://github.com/hedzr/go-ringbuf/workflows/Go/badge.svg)
 [![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/hedzr/go-ringbuf.svg?label=release)](https://github.com/hedzr/go-ringbuf/releases)
@@ -19,11 +19,14 @@ MPMC (multiple-producers and multiple consumers) enabled.
 
 ## History
 
-WIP:
- - english documentation not completed yet
- - documentation at: https:
+### v2.0.0 @20220408 - go 1.18+
 
-### v1.0.0
+generic version for MPMC Ring Buffer.
+
+- rewritten with go generics
+
+
+### v1.0.0 @20220408
 
 Last release for classical version.
 
@@ -42,29 +45,45 @@ Next release (v2) will move to go 1.18+ with generic enabled.
 ## Getting Start
 
 ```bash
-go get -v github.com/hedzr/go-ringbuf
+go get -v github.com/hedzr/go-ringbuf/v2
 ```
 
-### Import
+
+### Samples
 
 ```go
-import "github.com/hedzr/go-ringbuf/fast"
-```
+package main
 
+import (
+	"fmt"
+	"github.com/hedzr/go-ringbuf/v2"
+	"log"
+)
 
+func main() {
+	testIntRB()
+	testStringRB()
+}
 
-### Simple 1
+func testStringRB() {
+	var err error
+	var rb = ringbuf.New[string](80)
+	err = rb.Enqueue("abcde")
+	errChk(err)
 
-```go
-import "github.com/hedzr/go-ringbuf/fast"
+	var item string
+	item, err = rb.Dequeue()
+	errChk(err)
+	fmt.Printf("dequeue ok: %v\n", item)
+}
 
-func main() {
+func testIntRB() {
 	var err error
-	var rb = fast.New(80)
+	var rb = ringbuf.New[int](80)
 	err = rb.Enqueue(3)
 	errChk(err)
-	
-	var item interface{}
+
+	var item int
 	item, err = rb.Dequeue()
 	errChk(err)
 	fmt.Printf("dequeue ok: %v\n", item)
@@ -81,6 +100,8 @@ func errChk(err error) {
 
 ### Using Ring-Buffer as a fixed resource pool
 
+The following codes is for v1, needed for rewriting
+
 ```go
 func newRes() *Res{...}
 
@@ -129,7 +150,8 @@ Welcome
 
 ## LICENSE
 
-MIT
+Apache 2.0
 
-
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fhedzr%2Fgo-ringbuf.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fhedzr%2Fgo-ringbuf?ref=badge_large)
\ No newline at end of file
+<!--
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fhedzr%2Fgo-ringbuf.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fhedzr%2Fgo-ringbuf?ref=badge_large)
+-->
\ No newline at end of file