Skip to content

Commit 1e628f0

Browse files
committed
Updated README
1 parent 66d22a7 commit 1e628f0

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Plotly.js Custom Vizualization Project - Splunk SE Summer Internship 2018
2-
The plotly.js visualization library packaged as a Splunk application to expose the charts via the Splunk Custom Visualization Framework
3-
2+
The [plotly.js](https://github.com/plotly/plotly.js/) charting library has been packaged into a Splunk application to expose the charts via the Splunk Custom Visualization Framework
43

54
Tamar A. Zamba - Lead Developer
65
SE Intern, Plano, TX
@@ -10,7 +9,19 @@ Analytics Architect, Washington, D.C.
109

1110
This modular visualization app includes:
1211
1. Candlestick/OHLC Chart - for Stocks and Financial Data. [Candlestick/OHLC source code](https://github.com/tmuth/plotly_custom_viz_splunk/blob/master/appserver/static/visualizations/candlestick_chart/src/visualization_source.js)
12+
2. Box Plot Chart - for displaying Statistical Data. [BoxPlot source code](https://github.com/tmuth/plotly_custom_viz_splunk/blob/master/appserver/static/visualizations/boxplot/src/visualization_source.js)
13+
14+
## Installation
15+
- [Download Splunk for your platform](http://www.splunk.com/download?r=productOverview).
16+
- Unpack/Install Splunk by running the downloaded files.
17+
- Follow the instruction on the screen.
1318

19+
Download the app **plotly_custom_viz_splunk** from **GitHub** and installed in your Splunk platform. Access your Splunk instance via terminal and:
20+
- browse to your apps directory `$SPLUNK_HOME/etc/apps/`
21+
- download the app from github `git clone https://github.com/tmuth/plotly_custom_viz_splunk`
22+
- Restart splunk to apply changes `$SPLUNK_HOME/bin/splunk restart`
23+
24+
## Usage
1425
Sample SPL Search for Candlestick/OHLC:
1526

1627
```sh
@@ -27,7 +38,6 @@ Sample SPL Search for Candlestick/OHLC:
2738
| fields - sign,count
2839
```
2940

30-
2. Box Plot Chart - for displaying Statistical Data. [BoxPlot source code](https://github.com/tmuth/plotly_custom_viz_splunk/blob/master/appserver/static/visualizations/boxplot/src/visualization_source.js)
3141

3242
Sample SPL Search for BoxPlot:
3343

@@ -39,4 +49,3 @@ Sample SPL Search for BoxPlot:
3949
| eval y=random() %51
4050
| fields - _time
4151
```
42-

0 commit comments

Comments
 (0)