Doc help

README.md

@@ -42,6 +42,69 @@ sudo apt install jq
 
 
 # Usage
+Not working yet, but have queries like:
+
+```
+$ ./xeno-crufto --cnt brazil
+```
+
+Help:
+
+```
+$ ./xeno-crufto -h
+usage: xeno-crufto [-h] [--api API] [--query QUERY] [--also ALSO] [--animal-seen ANIMAL_SEEN] [--auto AUTO] [--bird-seen BIRD_SEEN] [--cnt CNT] [--date DATE]
+                   [--dvc DVC] [--en EN] [--file FILE] [--file-name FILE_NAME] [--gen GEN] [--group GROUP] [--id ID] [--lat LAT] [--length LENGTH] [--lic LIC]
+                   [--lng LNG] [--loc LOC] [--method METHOD] [--mic MIC] [--osci OSCI] [--playback-used PLAYBACK_USED] [--q Q] [--rec REC] [--regnr REGNR]
+                   [--rmk RMK] [--sex SEX] [--smp SMP] [--sono SONO] [--sp SP] [--ssp SSP] [--stage STAGE] [--temperature TEMPERATURE] [--time TIME] [--type TYPE]
+                   [--uploaded UPLOADED] [--url URL]
+
+options:
+  -h, --help            show this help message and exit
+  --api API             API URL (default https://xeno-canto.org/api/2/recordings)
+  --query QUERY         Search Query (default None)
+  --also ALSO           an array with the identified background species in the recording
+  --animal-seen ANIMAL_SEEN
+                        was the recorded animal seen?
+  --auto AUTO           (non-supervised) recording?
+  --bird-seen BIRD_SEEN
+                        despite the field name (which was kept to ensure backwards compatibility), this field indicates whether the recorded animal was seen
+  --cnt CNT             the country where the recording was made
+  --date DATE           the date that the recording was made
+  --dvc DVC             recording device used
+  --en EN               the English name of the species
+  --file FILE           the original file name of the audio file
+  --file-name FILE_NAME
+                        the URL to the audio file
+  --gen GEN             the generic name of the species
+  --group GROUP         the group to which the species belongs (birds, grasshoppers, bats)
+  --id ID               the catalogue number of the recording on xeno-canto
+  --lat LAT             the latitude of the recording in decimal coordinates
+  --length LENGTH       the length of the recording in minutes
+  --lic LIC             the URL describing the license of this recording
+  --lng LNG             the longitude of the recording in decimal coordinates
+  --loc LOC             the name of the locality
+  --method METHOD       the recording method (field recording, in the hand, etc.)
+  --mic MIC             microphone used
+  --osci OSCI           an object with the urls to the three versions of oscillograms
+  --playback-used PLAYBACK_USED
+                        was playback used to lure the animal?
+  --q Q                 the current quality rating for the recording
+  --rec REC             the name of the recordist
+  --regnr REGNR         registration number of specimen (when collected)
+  --rmk RMK             additional remarks by the recordist
+  --sex SEX             the sex of the animal
+  --smp SMP             sample rate
+  --sono SONO           an object with the urls to the four versions of sonograms
+  --sp SP               the specific name (epithet) of the species
+  --ssp SSP             the subspecies name (subspecific epithet)
+  --stage STAGE         the life stage of the animal (adult, juvenile, etc.)
+  --temperature TEMPERATURE
+                        temperature during recording (applicable to specific groups only)
+  --time TIME           the time of day that the recording was made
+  --type TYPE           the sound type of the recording (combining both predefined terms such as 'call' or 'song' and additional free text options)
+  --uploaded UPLOADED   the date that the recording was uploaded to xeno-canto
+  --url URL             the URL specifying the details of this recording
+```
 
 
 # Development