From af728d8f3c29d6237d381a4a6ebc132ca2866991 Mon Sep 17 00:00:00 2001 From: Carlos Gutierrez Date: Mon, 22 Nov 2021 13:00:37 -0600 Subject: [PATCH] chore: adding readme --- README.md | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a0eaff0..a451828 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,21 @@ # Convert time GMT -convert the timestamp in a format dd/mm/yyyy hh:mm:ss +convert the timestamp in a format dd/mm/yyyy hh:mm:ss with GMT as default -[![GitHub version][github-image]][github-url] -[![downloads][downloads-image]][npm-url] -[![license][license-image]][license-url] -[![GitHub code size in bytes][size-image]][github-url] +## Installing -[![npm release][npm-image]][npm-url] \ No newline at end of file +npm i convert-time-gmt --save + +## Usage + +On the main file: + +```js +const gmtConversion = require('convert-time-gmt') + +gmtConversion() // 2021/22/11 12:00:00 + +gmtConversion(new Date()) // 2021/22/11 12:00:00 + +gmtConversion(new Date(), 'GMT-05:00') // 2021/22/11 07:00:00 +```