From bd0f7f9ed5937e78fd7653642f9c43d9371387c0 Mon Sep 17 00:00:00 2001 From: Joe Germuska Date: Mon, 3 Feb 2014 13:55:24 -0600 Subject: [PATCH] explain more clearly how to load the JS/CSS if you aren't using the embed tool --- README.markdown | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.markdown b/README.markdown index 6ae6541..1f8a329 100644 --- a/README.markdown +++ b/README.markdown @@ -5,6 +5,7 @@ - [Add it to your site](#add-it-to-your-site) - [Using Inline (easiest)](#using-inline-easiest) - [Using a method (advanced)](#using-a-method-advanced) + - [Loading the files](#loading-the-files) - [Config Options](#config-options) - [Language](#language) - [Start at End](#start-at-end) @@ -40,6 +41,7 @@ Creating one is as easy as filling in a Google spreadsheet or as detailed as JSON. ## Add it to your site + ### Using Inline (*easiest*) Place the embed code where you want the timeline to show in the `` of your site. See [Config Options](#config-options) for a full list of what you can set in the config. @@ -63,7 +65,7 @@ Place the embed code where you want the timeline to show in the `` of your js: 'path_to_js/timeline-min.js' //OPTIONAL PATH TO JS } - + ``` ### Using a method (*advanced*) You could also initialize a new timeline using the `createStoryJS` method after `storyjs-embed.js` has been loaded @@ -84,7 +86,7 @@ Here's a simple example: - + + + + +``` + +If you need to use the files on an HTTPS server, you can change the beginning of the url from `http://cdn.knightlab.com/libs/timeline/` to `https://s3.amazonaws.com/cdn.knightlab.com/libs/timeline/` + +If you need to serve copies of the files from your own server, use the entire contents of the ["/build/" directory](https://github.com/NUKnightLab/TimelineJS/tree/master/build) of our GitHub repository. If you use a local copy of `story-embed.js` it should automatically load the other Timeline resources from your server. ## Config Options Here are some of the options you can set in the config.