Add notice about file not being used by default

perliedman · Feb 2, 2017 · 94d57d0 · 94d57d0
1 parent 7a9ad08
commit 94d57d0
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/localization.js b/src/localization.js
@@ -1,3 +1,13 @@
+/* 
+   NOTICE
+   Since version 3.2.5, the functionality in this file is by
+   default NOT used for localizing OSRM instructions.
+   Instead, we rely on the module osrm-text-instructions (https://github.com/Project-OSRM/osrm-text-instructions/).
+   
+   This file can still be used for other routing backends, or if you specify the
+   stepToText option in the OSRMv1 class.
+*/
+
 (function() {
 	'use strict';