LogalDeveloper/Minecraft-Overviewer
Archived
0
Fork 0
Code Activity

readme: add API key note, small fixes

Browse Source 
We previously stated that a Google Maps API key is not required.
However, this is not true (anymore). I'm still wary of adding
it to the documentation since my hopes is that in the time it would
take me to add this to the docs I could just finish leaflet, but this
is the least we can do to clear up any confusion.

Also switched some URLs to use HTTPS, which closes #1314.

Lastly, fixed a warning about a not long enough title line.
This commit is contained in:
Nicolas F
2017-04-10 12:18:14 +02:00
parent dd96d95b66
commit e07e588e59
1 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.rst
View File

@@ -1,19 +1,19 @@
==================== ====================================
Minecraft Overviewer |Build Status| Minecraft Overviewer |Build Status|
==================== ====================================
By Andrew Brown and contributors (see CONTRIBUTORS.rst). By Andrew Brown and contributors (see CONTRIBUTORS.rst).
Documentation: Documentation:
http://docs.overviewer.org http://docs.overviewer.org
Github code repository: Github code repository:
http://github.com/overviewer/Minecraft-Overviewer https://github.com/overviewer/Minecraft-Overviewer
Travis-CI: Travis-CI:
http://travis-ci.org/overviewer/Minecraft-Overviewer https://travis-ci.org/overviewer/Minecraft-Overviewer
Blog: Blog:
http://overviewer.org/blog/ https://overviewer.org/blog/
The Minecraft Overviewer is a command-line tool for rendering high-resolution The Minecraft Overviewer is a command-line tool for rendering high-resolution
@@ -69,12 +69,13 @@ directory hierarchy full of images. To view your world, simply open index.html
in a web browser. Internet access is required to load the Google Maps API in a web browser. Internet access is required to load the Google Maps API
files, but you otherwise don't need anything else. files, but you otherwise don't need anything else.
You can throw these files up to a web server to let others view your map. You You can throw these files up to a web server to let others view your map. To
do *not* need a Google Maps API key (as was the case with older versions of the ensure the map works when viewed through the Internet, you'll need a Google
API), so just copying the directory to your web server should suffice. You are, Maps API key, which you can `get for free from Google`_. Please note that you
however, bound by the Google Maps API terms of service. are also bound by the `Google Maps API Terms of Service`_.
https://developers.google.com/maps/terms .. _get for free from Google: https://developers.google.com/maps/documentation/javascript/get-api-key
.. _Google Maps API Terms of Service: https://developers.google.com/maps/terms
Bugs Bugs
==== ====