Merge pull request Workiva#62 from alexandercampbell-wf/update_readme

Update readme

Author: alexandercampbell-wk

README.md

@@ -14,9 +14,6 @@ Bitarray used to detect existence without having to resort to hashing with hashm
 #### Futures: 
 A helpful tool to send a "broadcast" message to listeners.  Channels have the issue that once one listener takes a message from a channel the other listeners aren't notified.  There were many cases when I wanted to notify many listeners of a single event and this package helps.
 
-#### Graph: 
-Still pretty specific to gotable, but contains logic required to maintain graph state.  Also has logic to flatten graph into executable chunks.
-
 #### Queue: 
 Package contains both a normal and priority queue.  Both implementations never block on send and grow as much as necessary.  Both also only return errors if you attempt to push to a disposed queue and will not panic like sending a message on a closed channel.  The priority queue also allows you to place items in priority order inside the queue.  If you give a useful hint to the regular queue, it is actually faster than a channel.  The priority queue is somewhat slow currently and targeted for an update to a Fibonacci heap.
 
@@ -57,20 +54,12 @@ Initial implementation of a B+ tree.  Delete method still needs added as well as
 
 ### Installation
 
-1) Install Go 1.3 or higher.
-
-2) Configure git to use SSH instead of HTTPS for github repositories. This
-allows `go get` to use private repositories.
-
-	# ~/.gitconfig
-	[url "[email protected]:"]
-		insteadOf = https://github.com
-
-3) go get github.com/Workiva/go-datastructures ...
+ 1. Install Go 1.3 or higher.
+ 2. Run `go get github.com/Workiva/go-datastructures/...`
 
 ### Updating
 
-When new code is merged to master, you can use 
+When new code is merged to master, you can use
 
 	go get -u github.com/Workiva/go-datastructures/...
 
@@ -84,15 +73,23 @@ To run all the unit tests use these commands:
 	go get -t -u ./...
 	go test ./...
 
-Once you've done this once, you can simply use
+Once you've done this once, you can simply use this command to run all unit tests:
 
 	go test ./...
 
+
 ### Notice
 
 Requirements to commit here:
 
  - `gofmt`'d code.
  - Compliance with [these guidelines](https://code.google.com/p/go-wiki/wiki/CodeReviewComments)
  - Unit test coverage
- - [Good commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+ - [Good commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+
+
+### Maintainers
+
+ - Dustin Hiatt <[[email protected]](mailto:[email protected])>
+ - Alexander Campbell <[[email protected]](mailto:[email protected])>
+

augmentedtree/interface.go

@@ -29,7 +29,6 @@ The current tree is a simple top-down red-black binary search tree.
 TODO: Add a bottom-up implementation to assist with duplicate
 range handling.
 */
-
 package augmentedtree
 
 // Interval is the interface that must be implemented by any

bitarray/interface.go

@@ -22,7 +22,6 @@ be done in a single clock cycle (not counting the time it takes to convert)
 the resultant array back into integers).  When Go implements a command
 to get trailing zeroes, the reconversion back into integers should be much faster.
 */
-
 package bitarray
 
 // BitArray represents a structure that can be used to

datastructures.go

@@ -10,10 +10,21 @@ importing this package instead of each subpackage individually.
 import (
 	_ "github.com/Workiva/go-datastructures/augmentedtree"
 	_ "github.com/Workiva/go-datastructures/bitarray"
+	_ "github.com/Workiva/go-datastructures/btree/link"
+	_ "github.com/Workiva/go-datastructures/btree/palm"
+	_ "github.com/Workiva/go-datastructures/btree/plus"
 	_ "github.com/Workiva/go-datastructures/futures"
+	_ "github.com/Workiva/go-datastructures/hashmap/fastinteger"
+	_ "github.com/Workiva/go-datastructures/numerics/optimization"
 	_ "github.com/Workiva/go-datastructures/queue"
 	_ "github.com/Workiva/go-datastructures/rangetree"
+	_ "github.com/Workiva/go-datastructures/rangetree/skiplist"
 	_ "github.com/Workiva/go-datastructures/set"
 	_ "github.com/Workiva/go-datastructures/slice"
+	_ "github.com/Workiva/go-datastructures/slice/skip"
+	_ "github.com/Workiva/go-datastructures/sort"
 	_ "github.com/Workiva/go-datastructures/threadsafe/err"
+	_ "github.com/Workiva/go-datastructures/tree/avl"
+	_ "github.com/Workiva/go-datastructures/trie/xfast"
+	_ "github.com/Workiva/go-datastructures/trie/yfast"
 )

hashmap/fastinteger/hashmap.go

@@ -18,7 +18,6 @@
 //
 // This performance could be further enhanced by using a
 // better probing technique.
-
 package fastinteger
 
 const ratio = .75 // ratio sets the capacity the hashmap has to be at before it expands

rangetree/interface.go

@@ -26,7 +26,6 @@ consumer that needs a threadsafe rangetree.
 
 TODO: unify both implementations with the same interface.
 */
-
 package rangetree
 
 // Entry defines items that can be added to the rangetree.

threadsafe/err/error.go

@@ -20,7 +20,6 @@ I found myself needing a lock to protect writing to a common error interface
 from multiple go routines (channels are great but slow).  This just makes
 that process more convenient.
 */
-
 package err
 
 import "sync"

tree/avl/avl.go

@@ -15,9 +15,11 @@ limitations under the License.
 */
 
 /*
-The immutable AVL tree can be used as the foundation for many functional
-data types.  Combined with a B+ tree, you can make an immutable index which
-serves as the backbone for many different kinds of key/value stores.
+Package avl includes an immutable AVL tree.
+
+AVL trees can be used as the foundation for many functional data types.
+Combined with a B+ tree, you can make an immutable index which serves as the
+backbone for many different kinds of key/value stores.
 
 Time complexities:
 Space: O(n)