Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tunnckoCore committed Feb 4, 2015
1 parent 01e6182 commit e8310fe
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 13 deletions.
16 changes: 11 additions & 5 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,25 @@
* var currentWeekNumber = require('current-week-number');
*
* // june 27, 2014
* currentWeekNumber()
* currentWeekNumber();
* //=> 26
*
* currentWeekNumber('March 24, 2015')
* currentWeekNumber('March 24, 2015');
* //=> 13
*
* currentWeekNumber('03/24/2016')
* currentWeekNumber(new Date('March 24, 2015'));
* //=> 13
*
* currentWeekNumber('03/24/2016');
* //=> 12, cuz' year is leap
*
* currentWeekNumber('August 07, 2015')
* currentWeekNumber('August 07, 2015');
* //=> 32
*
* currentWeekNumber('02/16/2015')
* currentWeekNumber(new Date('August 07, 2016'));
* //=> 31
*
* currentWeekNumber('02/16/2015');
* //=> 8
* ```
*
Expand Down
22 changes: 14 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
> Get current week number of the current year or given date string format.
## Install
```bash
npm install current-week-number
```
npm i --save current-week-number
npm test
```

Expand All @@ -24,19 +24,25 @@ npm test
var currentWeekNumber = require('current-week-number');

// june 27, 2014
currentWeekNumber()
currentWeekNumber();
//=> 26

currentWeekNumber('March 24, 2015')
currentWeekNumber('March 24, 2015');
//=> 13

currentWeekNumber(new Date('March 24, 2015'));
//=> 13

currentWeekNumber('03/24/2016')
currentWeekNumber('03/24/2016');
//=> 12, cuz' year is leap

currentWeekNumber('August 07, 2015')
currentWeekNumber('August 07, 2015');
//=> 32

currentWeekNumber('02/16/2015')
currentWeekNumber(new Date('August 07, 2016'));
//=> 31

currentWeekNumber('02/16/2015');
//=> 8
```

Expand Down Expand Up @@ -80,4 +86,4 @@ Released under the [`MIT`][license-url] license.

***

_Powered and automated by [kdf](https://github.com/tunnckoCore), January 26, 2015_
_Powered and automated by [kdf](https://github.com/tunnckoCore), February 4, 2015_

0 comments on commit e8310fe

Please sign in to comment.