Skip to content

Commit b06cc46

Browse files
author
David Blackman
authored
Update README.md
1 parent d537461 commit b06cc46

File tree

1 file changed

+16
-21
lines changed

1 file changed

+16
-21
lines changed

README.md

+16-21
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,22 @@ COMPARE_CONFIG_FILE=config.hjson ./api.sh \
7070

7171
Because I've defined a "prod" entry in config.hjson, and put keys into .env, this command will execute wth the necessary authentication.
7272

73+
74+
## Output
75+
76+
### [text (console) output](https://radarlabs.github.io/compare/demos/text-diff-as-html.html)
77+
```./compare.sh --new.host localhost:4100 --old.host localhost:3100 --input_csv addresses.csv --endpoint /v1/search --extra_params size=1 sources=osm,gn,wof --ignored_fields bbox geometry attribution timestamp via parsed_text gid id source_id --output_mode text --color > out.txt```
78+
79+
![start of text diff](https://radarlabs.github.io/compare/demos/text-output-2.png)
80+
![end of text diff](https://radarlabs.github.io/compare/demos/text-output-1.png)
81+
82+
- [full output as text](https://radarlabs.github.io/compare/demos/diff.txt) - this is much prettier in a terminal due to escape characters. The header links to a version of this output wrapped in an html viewer for ansi escape codes.
83+
84+
### [html output](https://radarlabs.github.io/compare/demos/diff.html)
85+
```./compare.sh --new.host localhost:4100 --old.host localhost:3100 --input_csv addresses.csv --endpoint /v1/search --extra_params size=1 sources=osm,gn,wof --ignored_fields bbox geometry attribution timestamp via parsed_text gid id source_id --output_mode html > out.html```
86+
87+
Note that this is an interactive evaluation form for figuring out which queries improved and which got worse. Each result is assigned an id based on the md5 hash of the query params + delta, and scores are saved to local storage. in your web browser. This means if you're doing a lot of compares, where many of the diffs are the same between runs, you won't need to re-rank them.
88+
7389
## Usage
7490

7591
This tool might seem like it has a zillion options, but I promise, it's not that bad!
@@ -168,24 +184,3 @@ These can be mixed!
168184
- `--color` - text mode only. whether or not to colorize the output. Defaults to true if sending to stdout, false if redirecting output. Use this option to force colorized output. Suggest always using it.
169185
- `--output_mode` - json, html or text (console output)
170186
- `--output_file` - defaults to stdout, where to output to
171-
172-
173-
## Output
174-
175-
### text (console) output
176-
```./compare.sh --new.host localhost:4100 --old.host localhost:3100 --input_csv addresses.csv --endpoint /v1/search --extra_params size=1 sources=osm,gn,wof --ignored_fields bbox geometry attribution timestamp via parsed_text gid id source_id --output_mode text --color > out.txt```
177-
178-
![start of text diff](https://radarlabs.github.io/compare/demos/text-output-2.png)
179-
![end of text diff](https://radarlabs.github.io/compare/demos/text-output-1.png)
180-
181-
- [full output](https://radarlabs.github.io/compare/demos/diff.txt) - this is much prettier in a terminal due to escape characters
182-
- [full text output rendered in an html page to look like a console](https://radarlabs.github.io/compare/demos/text-diff-as-html.html)
183-
184-
### html output
185-
```./compare.sh --new.host localhost:4100 --old.host localhost:3100 --input_csv addresses.csv --endpoint /v1/search --extra_params size=1 sources=osm,gn,wof --ignored_fields bbox geometry attribution timestamp via parsed_text gid id source_id --output_mode html > out.html```
186-
187-
[full output](https://radarlabs.github.io/compare/demos/diff.html)
188-
189-
Note that this is an interactive evaluation form for figuring out which queries improved and which got worse. Each result is assigned an id based on the md5 hash of the query params + delta, and scores are saved to local storage. in your web browser. This means if you're doing a lot of compares, where many of the diffs are the same between runs, you won't need to re-rank them.
190-
191-

0 commit comments

Comments
 (0)