summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6d941ed
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# AGL Reference POI application
+### This application provides the function of destination search to AGL. It uses the API provided by AGL Reference Navigation. This application uses yelp WebAPI.
+
+### The settings required to run POI application are as follows:
+
+#### 1. Please connect to the Internet. (Because POI-App uses yelp's web-API)
+
+#### 2. Please register yelp
+
+##### https://www.yelp.co.jp/developers?country=US
+##### Please do developer registration and obtain App ID and App Secret key.
+##### And please write it in /etc/poikey
+
+##### The contents are as follows (2 lines):
+###### your app id
+###### your sercret key
+
+### Restrictions:
+#### POI App uses Navigation API. Push Navigation button before POI app.