diff --git a/README.md b/README.md index b75ca40..a1f4385 100644 --- a/README.md +++ b/README.md @@ -3,17 +3,20 @@ jQuery timeline plugin, easily creates a timeline.  -Getting Started: -------- +## Getting Started +#### 1.1. Installation with Package Managers Timeline.js is now setup and ready to be used with [Bower](https://bower.io/) and [NPM](https://www.npmjs.com/package/timelinejs-slider) and can be installed using the following commands. ```shell bower install timelinejs-slider +``` +```shell npm install timelinejs-slider ``` +#### 1.2. The Basics Include the jQuery library and plugin: ```html @@ -52,7 +55,7 @@ $(function(){ ``` -Options: +## Options _Available options listed below._ ```js @@ -85,18 +88,16 @@ $('.timeline').Timeline({ ``` -Demo -------- +## Demo https://ilkeryilmaz.github.io/timelinejs/ -Tasks -------- +## Tasks - [x] ~~Basic plugin~~ - [x] ~~Demo page and documentation~~ - [ ] Mouse drag and touch support - [ ] Mobile support - [ ] Next/prev button -- [ ] Advanced features (date slider, autoplay etc.) +- [ ] Advanced features (date slider, ~~autoplay~~.) diff --git a/demo/css/demo.css b/demo/css/demo.css index ca6f6d9..c26962f 100644 --- a/demo/css/demo.css +++ b/demo/css/demo.css @@ -48,6 +48,9 @@ code { font-size: 90%; background-color: #f6f8fa; border-radius: .25rem; } + code .pln, + code .pun { + color: #4A2AB2; } .header-wrapper { padding: 5rem 0; } @@ -77,6 +80,8 @@ code { @media (min-width: 576px) { .section-list { border-radius: 1rem; } } + .section-list a { + color: #4A2AB2; } .section-list h2 { margin-bottom: 1.25rem; font-size: 2rem; diff --git a/demo/css/demo.scss b/demo/css/demo.scss index 966ffb4..ce9addb 100644 --- a/demo/css/demo.scss +++ b/demo/css/demo.scss @@ -64,6 +64,11 @@ code { font-size: 90%; background-color: #f6f8fa; border-radius: .25rem; + + .pln, + .pun{ + color: $color-primary; + } } // Header @@ -106,6 +111,10 @@ code { border-radius: 1rem; } + a { + color: $color-primary; + } + h2 { margin-bottom: 1.25rem; font-size: 2rem; diff --git a/demo/index.html b/demo/index.html index dd8dce9..29afa7d 100644 --- a/demo/index.html +++ b/demo/index.html @@ -37,6 +37,19 @@
Timeline.js is now setup and ready to be used with Bower and NPM and can be installed using the following commands. +
+
+bower install timelinejs-slider
+
+
+npm install timelinejs-slider
+
+ Include the jQuery library and plugin:
diff --git a/package.json b/package.json index 60d6bb6..a1a909c 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "timelinejs-slider", "description": "jQuery timeline plugin, easily creates a timeline.", - "version": "0.0.1", + "version": "0.1.0", "repository": "https://github.com/ilkeryilmaz/timelinejs", "license": "MIT", "devDependencies": {