Skip to content

Commit

Permalink
Updated the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
wisdom.emenike committed Jan 31, 2019
1 parent ac7eecf commit 4fe5e9c
Show file tree
Hide file tree
Showing 2 changed files with 88 additions and 80 deletions.
148 changes: 76 additions & 72 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,82 +4,86 @@ A slide-show library running on JQuery
slideWiz only wants to be bound with a html element as follows

```javascript
$('.slide-container').slideWiz({
auto: true,
speed: 5000,
row: 12,
col: 35,
animation: [
'flip',
'slice',
'box3D',
'pixel',
'fade',
'glide',
'card'
],
file: [
{
src: {
main: "image/main.png",
cover: "image/cover_1.jpg"
},
title: 'slideWiz Library - 1',
desc: "1: slideWiz is a JQuery based library created by a Nigerian Software Engineer by the name " +
"'Wisdom Emenike' who at the time of writing this library works at Imaxinacion Technology, one of Nigeria's leading IT companies.",
descLength: 220,
button: {
text: 'GitHub - 1',
url: 'https://github.com/iamwizzdom/slideWiz',
class: 'btn btn-medium btn-primary'
}
$('.slide-container').slideWiz({
auto: true,
speed: 5000,
row: 12,
col: 35,
animation: [
'flip',
'slice',
'box3D',
'pixel',
'fade',
'glide',
'card'
],
file: [
{
src: {
main: "image/main.png",
cover: "image/cover_1.jpg"
},
{
src: {
main: "image/main.png",
cover: "image/cover_2.jpg"
},
title: 'slideWiz Library - 2',
desc: "2: slideWiz is a JQuery based library created by a Nigerian Software Engineer by the name " +
"'Wisdom Emenike' who at the time of writing this library works at Imaxinacion Technology, one of Nigeria's leading IT companies.",
button: {
text: 'GitHub - 2',
url: 'https://github.com/iamwizzdom/slideWiz',
class: 'btn btn-medium btn-primary'
}
title: 'slideWiz Library - 1',
desc: "1: slideWiz is a JQuery based library created by a Nigerian Software " +
"Engineer by the name 'Wisdom Emenike' who at the time of writing this library " +
"works at Imaxinacion Technology, one of Nigeria's leading IT companies.",
descLength: 220,
button: {
text: 'GitHub - 1',
url: 'https://github.com/iamwizzdom/slideWiz',
class: 'btn btn-medium btn-primary'
}
},
{
src: {
main: "image/main.png",
cover: "image/cover_2.jpg"
},
{
src: {
main: "image/main.png",
cover: "image/cover_3.jpg"
},
title: 'slideWiz Library - 3',
desc: "3: slideWiz is a JQuery based library created by a Nigerian Software Engineer by the name " +
"'Wisdom Emenike' who at the time of writing this library works at Imaxinacion Technology, one of Nigeria's leading IT companies.",
descLength: 190,
button: {
text: 'GitHub - 3',
url: 'https://github.com/iamwizzdom/slideWiz',
class: 'btn btn-medium btn-primary'
}
title: 'slideWiz Library - 2',
desc: "2: slideWiz is a JQuery based library created by a Nigerian Software " +
"Engineer by the name 'Wisdom Emenike' who at the time of writing this library " +
"works at Imaxinacion Technology, one of Nigeria's leading IT companies.",
button: {
text: 'GitHub - 2',
url: 'https://github.com/iamwizzdom/slideWiz',
class: 'btn btn-medium btn-primary'
}
},
{
src: {
main: "image/main.png",
cover: "image/cover_3.jpg"
},
{
src: {
main: "image/main.png",
cover: "image/cover_4.jpg"
},
title: 'slideWiz Library - 4',
desc: "4: slideWiz is a JQuery based library created by a Nigerian Software Engineer by the name " +
"'Wisdom Emenike' who at the time of writing this library works at Imaxinacion Technology, one of Nigeria's leading IT companies.",
button: {
text: 'GitHub - 4',
url: false,
class: 'btn btn-medium btn-primary'
}
title: 'slideWiz Library - 3',
desc: "3: slideWiz is a JQuery based library created by a Nigerian Software " +
"Engineer by the name 'Wisdom Emenike' who at the time of writing this library " +
"works at Imaxinacion Technology, one of Nigeria's leading IT companies.",
descLength: 190,
button: {
text: 'GitHub - 3',
url: 'https://github.com/iamwizzdom/slideWiz',
class: 'btn btn-medium btn-primary'
}
]

});
},
{
src: {
main: "image/main.png",
cover: "image/cover_4.jpg"
},
title: 'slideWiz Library - 4',
desc: "4: slideWiz is a JQuery based library created by a Nigerian Software " +
"Engineer by the name 'Wisdom Emenike' who at the time of writing this library " +
"works at Imaxinacion Technology, one of Nigeria's leading IT companies.",
button: {
text: 'GitHub - 4',
url: false,
class: 'btn btn-medium btn-primary'
}
}
]

});
```

slideWiz accept an array of objects as a parameter, the object having four attributes each.
Expand Down
20 changes: 12 additions & 8 deletions js/slideShow.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,9 @@ $(document).ready(function () {
cover: "image/cover_1.jpg"
},
title: 'slideWiz Library - 1',
desc: "1: slideWiz is a JQuery based library created by a Nigerian Software Engineer by the name " +
"'Wisdom Emenike' who at the time of writing this library works at Imaxinacion Technology, one of Nigeria's leading IT companies.",
desc: "1: slideWiz is a JQuery based library created by a Nigerian Software " +
"Engineer by the name 'Wisdom Emenike' who at the time of writing this library " +
"works at Imaxinacion Technology, one of Nigeria's leading IT companies.",
descLength: 220,
button: {
text: 'GitHub - 1',
Expand All @@ -38,8 +39,9 @@ $(document).ready(function () {
cover: "image/cover_2.jpg"
},
title: 'slideWiz Library - 2',
desc: "2: slideWiz is a JQuery based library created by a Nigerian Software Engineer by the name " +
"'Wisdom Emenike' who at the time of writing this library works at Imaxinacion Technology, one of Nigeria's leading IT companies.",
desc: "2: slideWiz is a JQuery based library created by a Nigerian Software " +
"Engineer by the name 'Wisdom Emenike' who at the time of writing this library " +
"works at Imaxinacion Technology, one of Nigeria's leading IT companies.",
button: {
text: 'GitHub - 2',
url: 'https://github.com/iamwizzdom/slideWiz',
Expand All @@ -52,8 +54,9 @@ $(document).ready(function () {
cover: "image/cover_3.jpg"
},
title: 'slideWiz Library - 3',
desc: "3: slideWiz is a JQuery based library created by a Nigerian Software Engineer by the name " +
"'Wisdom Emenike' who at the time of writing this library works at Imaxinacion Technology, one of Nigeria's leading IT companies.",
desc: "3: slideWiz is a JQuery based library created by a Nigerian Software " +
"Engineer by the name 'Wisdom Emenike' who at the time of writing this library " +
"works at Imaxinacion Technology, one of Nigeria's leading IT companies.",
descLength: 190,
button: {
text: 'GitHub - 3',
Expand All @@ -67,8 +70,9 @@ $(document).ready(function () {
cover: "image/cover_4.jpg"
},
title: 'slideWiz Library - 4',
desc: "4: slideWiz is a JQuery based library created by a Nigerian Software Engineer by the name " +
"'Wisdom Emenike' who at the time of writing this library works at Imaxinacion Technology, one of Nigeria's leading IT companies.",
desc: "4: slideWiz is a JQuery based library created by a Nigerian Software " +
"Engineer by the name 'Wisdom Emenike' who at the time of writing this library " +
"works at Imaxinacion Technology, one of Nigeria's leading IT companies.",
button: {
text: 'GitHub - 4',
url: false,
Expand Down

0 comments on commit 4fe5e9c

Please sign in to comment.