graphblas BFS png

Author: Wimmerer

docs/Project.toml

@@ -1,2 +1,3 @@
 [deps]
-Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+SuiteSparseGraphBLAS = "c2e53296-7b14-11e9-1210-bddfa8111e1d"

docs/src/assets/AdjacencyMatrixBFS.png

@@ -3,7 +3,9 @@
 SuiteSparseGraphBLAS.jl is a WIP package for sparse linear algebra on arbitrary semirings, with a particular focus on graph computations.
 It is a wrapper over the Tim Davis' SuiteSparse reference implementation of the GraphBLAS C API, although it aims to expose a Julian interface to the user.
 
-While the core library is mostly complete, and all GraphBLAS functionality is present, there are still quite a few features being worked on:
+# Roadmap
+
+While the core library is mostly complete, and all GraphBLAS functionality is present, there are still quite a few features being worked on for v1.0:
 
 1. ChainRules.jl integration for AD.
 2. Complete SparseArrays and ArrayInterface interfaces.
@@ -15,4 +17,33 @@ While the core library is mostly complete, and all GraphBLAS functionality is pr
 
 Once these are completed there will be a v1.0 release, with the goal being JuliaCon 2021.
 
-# Introduction
+Post 1.0 goals include:
+
+1. LightGraphs integration.
+2. GeometricFlux or other graph machine learning framework integration.
+3. More efficient import and export between Julia and GraphBLAS
+4. Support for other GraphBLAS implementations in a follow-up GraphBLAS.jl
+
+# Installation
+
+Install using the Julia package manager in the REPL:
+
+```
+] add SuiteSparseGraphBLAS#master
+```
+
+or with `Pkg`
+
+```
+using Pkg
+Pkg.add("SuiteSparseGraphBLAS")
+```
+
+The SuiteSparse:GraphBLAS binary is installed automatically as `SSGraphBLAS_jll`.
+
+# Introduction
+
+GraphBLAS harnesses the well-understood duality between graphs and matrices. Specifically a graph 
+can be represented by its adjacency matrix, incidence matrix, or the many variations on those formats. With this matrix representation in hand we have a method to operate on the graph using linear algebra operations on the matrix.
+
+![BFS](./assets/AdjacencyMatrixBFS.png)