Init
authorEthan Nelson <git@ethan-nelson.com>
Sun, 16 Dec 2018 01:43:00 +0000 (19:43 -0600)
committerEthan Nelson <git@ethan-nelson.com>
Sun, 16 Dec 2018 01:43:00 +0000 (19:43 -0600)
LICENSE [new file with mode: 0644]
README.md [new file with mode: 0644]

diff --git a/LICENSE b/LICENSE
new file mode 100644 (file)
index 0000000..3129f0a
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,22 @@
+MIT License (MIT)
+
+Copyright (c) 2018 Ethan Nelson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..60e6945
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Leaflet Storymap
+
+This is an implementation of a story map using a Leaflet slippy map. This is not a unique feature but one I could not find a compatible implementation for elsewhere.
+
+It is still a work in progress, but this repository contains all the files needed to create a Leaflet supported story map on a single web page. The HTML, CSS, and Javascript can of course be implemented into a larger web project just as it is with my personal site.
+
+[MIT license](LICENSE) Copyright 2018 Ethan Nelson
+
+# Story Format
+
+The data for the story map is stored in [a comma-separated file](storydata.csv). An example CSV file is included to demonstrate the syntax:
+
+```
+id, title, lat, lon, zoom, text, image
+```
+
+Note that lines are not terminated by a comma and that commas are only allowed in the text column. Text in the text column should also be enclosed in `"` characters only. All of these requirements are because of the to-be-explained hack in conversion.
+
+Once the csv file is completed, [a script](convert.csv) converts the csv into a [javascript file](storydata.js) that is a Javascript defined array of geoJSON structure. This geoJSON is then read and processed by the story map page.
+
+# Map Tiles
+
+[OpenStreetMap tiles](https://www.openstreetmap.org) are used in the default page. Please be sure to read their [acceptable tile use policy](https://operations.osmfoundation.org/policies/tiles/) if you are using this code in your own site and also respect their [copyright](https://www.openstreetmap.org/copyright).
+
+# Closing
+
+I hope this project may be of help to you. Please file a GitHub issue if you have any feedback, questions, or concerns. Pull requests are welcomed! 
+
+Finally, if this project helped you out, [drop me a line](mailto:git@ethan-nelson.com) as I would love to hear about your awesome work!