Skip to content

Commit 45943df

Browse files
committed
Updated README
1 parent 3ad5c96 commit 45943df

File tree

1 file changed

+40
-27
lines changed

1 file changed

+40
-27
lines changed

README.md

Lines changed: 40 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,23 @@
44

55
The QuickValuesPlus Widget is a fork of the GrayLog2 Quick Values Widget that ships with GrayLog2.
66

7-
When the QuickValuesPlus Widget is added to a stream as a field analyzer it adds a "Remove from search" column. The button will negate the field in the search bar (E.g. !field_name:foo).
7+
When the QuickValuesPlus Widget is added to a stream as a field analyzer it adds a "Remove from search" button. The button will negate the field in the search bar (E.g. !field_name:foo).
88

9-
In addition, the QuickValuesPlus Widget has extra features when added to a dashboard such as:
9+
![alt text](https://www.dropbox.com/s/a4ooar8u7j6bqd2/remove_from_search_button.PNG?dl=0 "Remove From Search Button")
10+
11+
In addition, the QuickValuesPlus Widget has extra features when added to dashboards, such as:
1012
* Support for **ascending** OR **descending** sort order in the datatable. Can now obtain true bottom values.
1113
* Editable number of Top/Bottom values (Quick Values default is 5). This is the one with a color in the table.
1214
* Customizable table size (Quick values default is 50).
1315

14-
**Required Graylog version:** 2.0 and later
16+
![alt text](https://www.dropbox.com/s/rwkqconcez262mg/Configuration%20Options.PNG?dl=0 "Example of Configuration Options")
17+
18+
**Required Graylog version:** 2.2 and later
1519

16-
The JAR was tested in GrayLog 2.1.3, but should hopefully work in others. Please file a bug report if not.
20+
Version 1.0.0 was tested and is compatible with Graylog version 2.1.3
21+
Version 2.0.0 was tested and is compatible with Graylog version 2.2.1
22+
23+
Please file a bug report providing as much detail as possible if you find that the plugin is not working.
1724

1825
Way Ahead (Next Version)
1926
-----------
@@ -38,34 +45,40 @@ dramatically by making use of hot reloading. To do this, do the following:
3845
* `ln -s $YOURPLUGIN plugin/`
3946
* `npm install && npm start`
4047

41-
If you run into issues with the current snapshot you can clone the 2.1.3 version of Graylog by using the following:
48+
If you run into issues with the current snapshot you can clone the 2.2.1 version of Graylog by using the following:
4249

43-
`git clone -b "2.1.3" https://github.com/Graylog2/graylog2-server.git`
50+
`git clone -b "2.2.1" https://github.com/Graylog2/graylog2-server.git`
4451

4552
**TIP** If you happen to use "[graylog-project](https://github.com/Graylog2/graylog-project)" and are having issues with the plugin compiling properly or not loading on the page, ensure your plugin's package.json has the same dependcies as "[graylog-plugin-sample](https://github.com/Graylog2/graylog-plugin-sample)". The example below has a few additional packages (crossfilter, d3, dc, deep-equal and immutable).
4653

4754
```
48-
"dependencies": {
49-
"reflux": "^0.2.12",
50-
"crossfilter": "1.3.x",
51-
"d3": "<=3.5.0",
52-
"dc": "2.0.0-beta.19",
53-
"deep-equal": "^1.0.1",
54-
"immutable": "^3.7.5"
55-
},
56-
"devDependencies": {
57-
"babel-core": "^5.x.x",
58-
"babel-loader": "^5.x.x",
59-
"graylog-web-manifests": "^2.0.0-SNAPSHOT-1",
60-
"graylog-web-plugin": "~0.0.17",
61-
"json-loader": "^0.5.4",
62-
"react": "^0.14.6",
63-
"react-bootstrap": "^0.28.2",
64-
"react-dom": "^0.14.6",
65-
"react-hot-loader": "^1.3.0",
66-
"react-proxy-loader": "^0.3.4",
67-
"webpack": "^1.12.2"
68-
}
55+
"dependencies": {
56+
"reflux": "^0.2.12",
57+
"crossfilter": "1.3.x",
58+
"d3": "<=3.5.0",
59+
"dc": "2.0.0-beta.19",
60+
"deep-equal": "^1.0.1",
61+
"immutable": "^3.7.5"
62+
},
63+
"devDependencies": {
64+
"babel-core": "^6.0.0",
65+
"babel-loader": "^6.0.0",
66+
"babel-plugin-add-module-exports": "^0.2.1",
67+
"babel-polyfill": "^6.0.0",
68+
"babel-preset-es2015": "^6.0.0",
69+
"babel-preset-react": "^6.0.0",
70+
"babel-preset-stage-0": "^6.0.0",
71+
"clean-webpack-plugin": "^0.1.3",
72+
"graylog-web-manifests": "^2.0.0-SNAPSHOT-1",
73+
"graylog-web-plugin": "~0.0.21",
74+
"json-loader": "^0.5.4",
75+
"react": "^0.14.6",
76+
"react-bootstrap": "^0.28.2",
77+
"react-dom": "^0.14.6",
78+
"react-hot-loader": "^3.0.0-beta.3",
79+
"react-proxy-loader": "^0.3.4",
80+
"webpack": "^1.12.2"
81+
}
6982
```
7083

7184
Usage

0 commit comments

Comments
 (0)