Skip to content

Commit 3f5953d

Browse files
authoredJul 9, 2017
Update readme.md
1 parent fd62abb commit 3f5953d

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed
 

‎readme.md

+16-5
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,23 @@ Detects lightning strikes around you and beeps as the thunder approches :zap:
44

55
## Installation
66
`git clone https://github.com/nicolas-t/petit-tonnerre.git`
7-
`cd petit-tonnerre`.
8-
`yarn install`.
7+
`cd petit-tonnerre`
8+
`yarn install`
99

10-
## Configuration
11-
open `petit-tonnerre.js`,
12-
update `myPosition` with your position's latitude and longitude.
10+
## Options
11+
you can list all options with `node petit-tonnerre.js --help`
12+
13+
`--latitude` : the latitude of your position
14+
`--longitude` : the longitude of your position
15+
`--radius` : the maximum distance (in meters) around your position a strike will be detected
16+
`--speed` : the speed of the sound (in meters per second)
17+
18+
## Examples
19+
__if you're in Hono Lulu:__
20+
`node petit-tonnerre.js --latitude=21.3069440 --longitude=-157.8583330`
21+
22+
__with all options:__
23+
`node petit-tonnerre.js --latitude=21.3069440 --longitude=-157.8583330 --radius=8000 --speed=342`
1324

1425
## Usage
1526
run `node petit-tonnerre.js` from the `petit-tonnerre` folder.

0 commit comments

Comments
 (0)
Please sign in to comment.