@bdougie/theweeknum
Advanced tools
Comparing version 0.0.5 to 0.1.0
{ | ||
"name": "@bdougie/theweeknum", | ||
"version": "0.0.5", | ||
"version": "0.1.0", | ||
"description": "a package that tells you the week number", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -1,9 +0,26 @@ | ||
# theWeekNum | ||
A package that tells you what week you are on. | ||
<h1 align="center">@bdougie/theweeknum 👋</h1> | ||
<p> | ||
<a href="https://www.npmjs.com/package/theweeknum"> | ||
<img alt="Version" src="https://img.shields.io/npm/v/theweeknum.svg"> | ||
</a> | ||
<a href="https://github.com/bdougie/theWeekNum#readme"> | ||
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" target="_blank" /> | ||
</a> | ||
<a href="https://github.com/bdougie/theWeekNum/graphs/commit-activity"> | ||
<img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" target="_blank" /> | ||
</a> | ||
<a href="https://github.com/bdougie/theWeekNum/blob/master/LICENSE"> | ||
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" target="_blank" /> | ||
</a> | ||
</p> | ||
> a package that tells you the week number | ||
# Examples usage | ||
### 🏠 [Homepage](https://github.com/bdougie/theWeekNum#readme) | ||
## Usage | ||
``` | ||
const weekNum = require('theweeknum') | ||
const weekNum = require('@bdougie/theweeknum') | ||
@@ -13,1 +30,34 @@ console.log(weekNum()) | ||
## Install | ||
```sh | ||
npm install @bdougie/theweeknum | ||
``` | ||
## Run tests | ||
```sh | ||
npm run test | ||
``` | ||
## Author | ||
👤 **bdougie** | ||
* Github: [@bdougie](https://github.com/bdougie) | ||
## 🤝 Contributing | ||
Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/bdougie/theWeekNum/issues). | ||
## Show your support | ||
Give a ⭐️ if this project helped you! | ||
## 📝 License | ||
Copyright © 2019 [bdougie](https://github.com/bdougie).<br /> | ||
This project is [MIT](https://github.com/bdougie/theWeekNum/blob/master/LICENSE) licensed. | ||
*** | ||
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_ |
5921
63