fix docstring and index.md install instructions (#314)

Author: Affie

README.md

@@ -22,7 +22,7 @@ add DistributedFactorGraphs
 
 # Usage
 DistributedFactorGraphs (DFG) currently supports two implementations:
-* An in-memory factor graph based on Graphs.jl
+* An in-memory factor graphs based on Graphs.jl and LightGraphs.jl
 * A Neo4j-based factor graph based on Neo4j.jl
 
 The in-memory implementation is the default. The Neo4j driver can be enabled by importing Neo4j before DFG:

docs/src/index.md

@@ -1,11 +1,17 @@
 # Introduction
 
-This package is a specialized Julia graphing wrapper.
+DistributedFactorGraphs.jl provides a flexible factor graph API for use in the [Caesar.jl](https://github.com/JuliaRobotics/Caesar.jl) ecosystem. The package supplies:
+* A standardized API for interacting with factor graphs
+* Implementations of the API for in-memory and database-driven operation
+* Visualization extensions to validate the underlying graph
+
+**Note** this package is still under initial development, and will adopt parts of the functionality currently contained in [IncrementalInference.jl](http://www.github.com/JuliaRobotics/IncrementalInference.jl).
 
 ## Installation
-This package is not yet registered with JuliaLang/METADATA.jl, but can be easily installed in Julia 0.6 with:
+
+DistributedFactorGraphs can be installed from Julia packages using:
 ```julia
-julia> ]add https://github.com/GearsAD/GraffSDK.jl.git
+julia> ]add DistributedFactorGraphs
 ```
 
 ## Manual Outline

src/services/AbstractDFG.jl

@@ -900,12 +900,12 @@ end
 ## Variable Data: VND and PPE
 ##==============================================================================
 
+#TODO API
 """
     $(SIGNATURES)
 Merges and updates solver and estimate data for a variable (variable can be from another graph).
 Note: Makes a copy of the estimates and solver data so that there is no coupling between graphs.
 """
-#TODO API
 function mergeVariableData!(dfg::AbstractDFG, sourceVariable::AbstractDFGVariable)::AbstractDFGVariable
 
     var = getVariable(dfg, sourceVariable.label)
@@ -921,12 +921,12 @@ function mergeVariableData!(dfg::AbstractDFG, sourceVariable::AbstractDFGVariabl
     return var
 end
 
+#TODO API
 """
     $(SIGNATURES)
 Common function to update all solver data and estimates from one graph to another.
 This should be used to push local solve data back into a cloud graph, for example.
 """
-#TODO API
 function mergeGraphVariableData!(destDFG::H, sourceDFG::G, varSyms::Vector{Symbol})::Nothing where {G <: AbstractDFG, H <: AbstractDFG}
     # Update all variables in the destination
     # (For now... we may change this soon)