ref: 75df370044d757a81a1e9dde14fb5d4d07ffc2e3
parent: 0bf28a1aa1e1067fb2e2e888772893ccd9b62347
author: M Misch <michaelmisch1985@gmail.com>
date: Mon Jun 3 10:32:54 PDT 2019
Fix formatting, add performance section
--- a/README.md
+++ b/README.md
@@ -1,27 +1,29 @@
# Search the web from the command line using a Google Custom Search engine
-# Should work anywhere you have access to a Factotum (Plan9, 9front, plan9port)
-## Installation
+Note: Should work anywhere you have access to a Factotum (Plan9, 9front, plan9port)
+## Installation
+```
go get github.com/halfwit/google
go install github.com/halfwit/google
+```
## Usage
google [[-i] [-it type] [-is size] [-ic color] [-id scale]] [-m results] [-r url] [-a key] [-f type] [-e match] [-x exclude] [ -s safe] query
- -m Number of results per query
- -r Search for sites related to [url]
- -a Use API key instead of factotum
- -f File type [bmp|gif|png|jpg|svg|pdf]
- -e Match string exactly
- -x Phrase to exclude
- -s Safe search [active|high|medium|off]
- -i Image search
-Requires -i
- -it Image type [clipart|face|lineart|news|photo]
- -is Image size [huge|icon|large|medium|small|xlarge|xxlarge]
- -ic Image color [black|blue|brown|gray|green|orange|ping|purple|red|teal|white|yellow]
- -id Image scale [color|gray|mono]
+ - -m Number of results per query
+ - -r Search for sites related to [url]
+ - -a Use API key instead of factotum
+ - -f File type [bmp|gif|png|jpg|svg|pdf]
+ - -e Match string exactly
+ - -x Phrase to exclude
+ - -s Safe search [active|high|medium|off]
+ - -i Image search
+### Requires -i
+ - -it Image type [clipart|face|lineart|news|photo]
+ - -is Image size [huge|icon|large|medium|small|xlarge|xxlarge]
+ - -ic Image color [black|blue|brown|gray|green|orange|ping|purple|red|teal|white|yellow]
+ - -id Image scale [color|gray|mono]
## Authentication
@@ -30,8 +32,8 @@
Additionally, you also have to create a Custom Search Engine itself.
Store these keys in your Factotum
-`gcli` - your API key (AIza...)
-`gcse` - your CSE key
+ - `gcli` - your API key (AIza...)
+ - `gcse` - your CSE key
## Performance (Subjective)