Skip to content

Commit e6d456a

Browse files
author
Marc-Alexandre Blanchard
committed
[doc] update README.md along side demo
1 parent ae4ae46 commit e6d456a

File tree

7 files changed

+44
-8
lines changed

7 files changed

+44
-8
lines changed

README.md

Lines changed: 44 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,63 @@
22

33
Simple app to ease custom location sending to Xcode Simulator.
44

5-
![](./demo/demo.gif)
65

7-
**Core features:**
6+
📍 Send location by searching an address or clicking on map
7+
![](./demo/v2.0.0/search-demo.gif)
88

9-
• Search location by address
9+
🏁 Automate location sending by providing a GeoJSON
10+
![](./demo/v2.0.0/routing-demo.gif)
1011

11-
• Click on map
12+
## A note on routing mode
1213

13-
**Planned features (ETA, when it's done):**
14+
### Playback capabilities
1415

15-
• Allow simulation of route, via .gpx import.
16+
- Play/Pause
17+
- Reset
18+
- Loop
19+
- Playback rate control (from 100ms to 5s)
20+
- Playback feedback on map (green part is what has been played)
1621

17-
• Add support for modern app icon via [./src/LocationSenderForSimulator/Icon.icon](./src/LocationSenderForSimulator/Icon.icon)
22+
### GeoJSON
23+
24+
Routing mode relies on [GeoJSON](https://geojson.org) file.
25+
26+
This way you can provide your own route made of WGS84 coordinates. Your GeoJSON may contain the following objects :
27+
28+
| Objects | Behavior |
29+
| - | - |
30+
| Linestring | Each point will be considered as part of the route |
31+
| MultiPoint | Each point will be considered as part of a single line/route |
32+
| Polygon | Each point will be considered as part of a single line/route |
33+
| MultiLineString | Only first line will be considered as route |
34+
| MultiPolygon | Only first polygon will be considered as route |
35+
| Feature | Geometry will be considered if it matches one of the previous enumerated type |
36+
| FeatureCollection | First feature with a supported geometry type will be considered |
37+
38+
_n.b as a result, every geometry made of less than two points are incompatible._
39+
40+
You can find sample [GeoJSON](https://geojson.org) files [here](./samples/).
41+
42+
Build your own via [geojson.io](https://geojson.io/)!
43+
44+
## Considered features (ETA, when it's done)
45+
46+
- Route playback based on speed instead of point rate
47+
- Add support for modern app icon via [./src/LocationSenderForSimulator/Icon.icon](./src/LocationSenderForSimulator/Icon.icon)
1848

1949
_n.b this app is not compatible with App Sandbox_
2050

2151
## Changelog
2252

53+
### v2.0.0
54+
55+
- [routing] Introduce routing mode via GeoJSON file
56+
- [search] It's now possible to send every location
57+
- [general] Improved UX
58+
2359
### v1.0.0
2460

25-
First version
61+
- First version
2662

2763
## Resources
2864

File renamed without changes.
File renamed without changes.

demo/v2.0.0/routing-demo.gif

12.1 MB
Loading

demo/v2.0.0/routing-demo.mov

50 MB
Binary file not shown.

demo/v2.0.0/search-demo.gif

9.61 MB
Loading

demo/v2.0.0/search-demo.mov

27.4 MB
Binary file not shown.

0 commit comments

Comments
 (0)