From baf8dffc42154596ce8b9ff9d0a74add09e6f5cf Mon Sep 17 00:00:00 2001 From: Omal Perera Date: Thu, 21 Dec 2017 01:22:21 +0530 Subject: [PATCH] Update README.md Corrected few typos in markdown topics --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 3deb801..721f4ce 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Scala client for the Lightning data visualization server (WIP) [![Build Status](https://travis-ci.org/lightning-viz/lightning-scala.svg?branch=master)](https://travis-ci.org/lightning-viz/lightning-scala) -##installation +## installation Build the project using `sbt` and the [assembly](https://github.com/sbt/sbt-assembly) plugin ``` sbt assembly @@ -13,9 +13,9 @@ To then use lightning in the scala REPL, just add the jar to your classpath (her scala -classpath target/scala-2.10/lightning-scala-assembly-0.1.0.jar ``` -##usage +## usage -###creating a new session +### creating a new session ``` import org.viz.lightning._ @@ -25,28 +25,28 @@ lgn.createSession() lgn.createSession("provide an optional session name") ``` -###creating a visualization +### creating a visualization Methods are available for the default visualization types included with Lightning ``` lgn.line(Array(Array(1.0,1.0,2.0,3.0,9.0,20.0))) lgn.scatter(Array(1.0,2.0,3.0), Array(1.0,1.5,5.0)) ``` -###setting options +### setting options Visualizations can be customized through optional parameters ``` lgn.line(Array(Array(1.0,1.0,2.0),Array(3.0,9.0,20.0)), label=Array(1,2)) lgn.scatter(Array(1.0,2.0,3.0), Array(1.0,1.5,5.0), label=Array(1,2,3)) ``` -###using a custom plot +### using a custom plot For any other plot type, just specify by name, and provide the data as a `Map` ``` lgn.plot("line", Map("series" -> List(1,1,2,3,9,20))) ``` This is especially useful when working with custom plot types -##tests +## tests Run the unit tests using `sbt` by calling ``` @@ -61,7 +61,7 @@ sbt "test-only *LightningPlotsSuite*" The tests require that a local lightning server is running on `http://localhost:3000` -##todo +## todo The following components need to be added - Add updating and appending - Add ability to post images