Skip to content

Markdown syntax fix. #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adnan-cefalo wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Markdown syntax fix. #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@ jquery-countdown

It is a very simple and light weight jQuery countdown plugin that supports progressbar and count from days to seconds.

#Usage
# Usage

##Files to load
## Files to load
You only need to load jQuery and this plugin. For example:

```html
<script src="//code.jquery.com/jquery.js"></script>
<script src="https://rawgit.com/eAdnan007/jquery-countdown/master/jquery.countdown.min.js"></script>
```

##Invoke
## Invoke
On a dom element, call method countdown() with/without your preferences.

```js
Expand All @@ -22,11 +22,11 @@ $('div').countdown({
});
```

#Supported Properties
# Supported Properties
Following properties are supported:
`start_time`, `end_time`, `show_day`, `show_hour`, `show_minute`, `show_second`, `update_int`, `progress`, `onComplete`, `wrapper`, `update_progress`

##start_time
## start_time
Specifies a time where the progressbar should have no progress(zero). You can pass any datetime string that is supported by javascript Data() object. However, I recommend the format, `YYYY/MM/DD hh:mm:ss +TZD`. Where,
YYYY = Year
MM = Month
Expand All @@ -39,33 +39,33 @@ TZD = Timezone UTC offset
Example:
`2016/06/21 14:27:28 +0600`

##end_time
## end_time
The countdown completes at this point and progressbar fills 100%. It support same input is `start_time`.

##show_day
## show_day
Wheather to show day count or not.

##show_hour
## show_hour
Wheather to show hour count or not.

##show_minute
## show_minute
Wheather to show minute count or not.

##show_second
## show_second
Wheather to show second count or not.

##update_int
## update_int
Interval between each updates of progressbar and timer.

##progress
## progress
There dom element which should display the progressbar. False if you don't want to display.

##onComplete
## onComplete
Function to trigger when countdown is done.

##wrapper
## wrapper
Modify the outer html of each countdown unit. This function receives a single argument, the name of the unit(Day, Hour, Minute, Second).
`Note: It must have an element with class counter; where the count will be displayed.`

##update_progress
Function to process the progress for the preogress bar. It receives two arguments, `Percentage of progress (0-100)` and `The dom element containing the progressbar`.
## update_progress
Function to process the progress for the preogress bar. It receives two arguments, `Percentage of progress (0-100)` and `The dom element containing the progressbar`.