Commit 6c057573 authored by Rory 's avatar Rory
Browse files

Update README

Added more warnings and put them under the new heading "Important
Caveats".
parent 88f5fe0f
......@@ -4,11 +4,17 @@ A simple plugin that is designed to provide geolocation data to a Unity game, ev
---
**Important note**: This isn't a real production plugin, it's more of a learning tool or proof of concept.
## Important Caveats
**This isn't a real production plugin**, it's more of a learning tool or proof of concept.
If you want to use something like this it would be smart to research the topic and make something that works for your specific project.
**Another important note**: Also be aware that the current version of this plugin (as of v1.0) doesn't contain any way to throttle location updates or stop them after a period of time.
Because of this it will **run forever in the background**, get very hot and eat a lot of battery life. This is something I'd love to change in future, but for now just be aware of it!
It also **only works with Android devices**, not iOS or Windows.
Finally, be aware that the current version of this plugin (as of v1.0) doesn't contain any way to throttle location updates or stop them after a period of time.
Because of this it will **run forever in the background**, get very hot and eat a lot of battery life. This is something I'd love to change in future, but for now you'll just have to deal with it!
---
## Overview
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment