Skip to content

Commit cce0c2a

Browse files
authored
Update README.md
1 parent cdd0bf8 commit cce0c2a

File tree

1 file changed

+0
-28
lines changed

1 file changed

+0
-28
lines changed

README.md

-28
Original file line numberDiff line numberDiff line change
@@ -65,34 +65,6 @@ private static void Alerts_OnAlertReceived(List<AlertCityData> cities)
6565
Console.WriteLine($"New Alert! [{occurence.ToShortDateString()}] {occurence.ToShortTimeString()}:\n" + string.Join("\n\n", result));
6666
}
6767
```
68-
69-
## Short documentation
70-
| Function | Parameters | Description | Returns |
71-
| ----------- | ----------- | ----------- | ----------- |
72-
| GetMapPhoto() | PathColorHex, Coordinates | Retrieves the bytes of the given coordinates image from Google Maps API with a path-line from Gaza-strip. | byte array |
73-
| RandomCoordinates() | Coordinates | Generates random coordinates within the given coordinates. | Coordinates |
74-
75-
---
76-
**AlertCityData**: <br>
77-
Name_he - returns the name of the alert city in Hebrew. <br>
78-
Name_en - returns the name of the alert city in English. <br>
79-
Name_ru - returns the name of the alert city in Russian. <br>
80-
Name_ar - returns the name of the alert city in Arabic. <br>
81-
<br>
82-
Zone_he - returns the name of the alert zone in Hebrew. <br>
83-
Zone_en - returns the name of the alert zone in English. <br>
84-
Zone_ru - returns the name of the alert zone in Russian. <br>
85-
Zone_ar - returns the name of the alert zone in Arabic. <br>
86-
<br>
87-
Countdown - returns the time to ran to into safe-zone. <br>
88-
Time_he - returns the time to ran to into safe-zone in Hebrew. <br>
89-
Time_en - returns the time to ran to into safe-zone in English. <br>
90-
Time_ru - returns the time to ran to into safe-zone in Russian. <br>
91-
Time_ar - returns the time to ran to into safe-zone in Arabic. <br>
92-
<br>
93-
Timestamp - returns the timestamp of the alert in "Israel Standard Time". <br>
94-
Coordinates - returns the coordinates of the alert.
95-
9668
## Information
9769
1) This library will only work for people whose locations is in Israel because Israel Home Front Command (Pikud Ha Oref) accepts only the requests from Israel.<br>
9870
2) The enemy cannot exploit or use this library for bad usage because it does not contain any private sensitive information, we use the public API of Israel Home Front Command (Pikud Ha Oref) <br>

0 commit comments

Comments
 (0)