From 40bcfc449d1bccc11b7dda08e1cfee1e41a079af Mon Sep 17 00:00:00 2001 From: Andrew Gillis Date: Tue, 1 May 2018 00:44:09 -0400 Subject: [PATCH] update readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d36aedf..5dbb8dd 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ Extremely fast ring-buffer deque ([double-ended queue](https://en.wikipedia.org/ [![GoDoc](https://godoc.org/github.com/gammazero/deque?status.svg)](https://godoc.org/github.com/gammazero/deque) +For a pictorial description, see the [Deque diagram](https://github.com/gammazero/deque/wiki) + ## Installation ``` @@ -31,8 +33,6 @@ For maximum speed, this deque implementation leaves concurrency safety up to the Since it is OK for the deque to contain a nil value, it is necessary to either panic or return a second boolean value to indicate the deque is empty, when reading or removing an element. This deque panics when reading from an empty deque. This is a run-time check to help catch programming errors, which may be missed if a second return value is ignored. Simply check Deque.Len() before reading from the deque. -For a pictorial description, see the [Deque diagram](https://github.com/gammazero/deque/wiki) - ## Example ```go