From 73b7673d07376d6fbfaa9b4f886cafd0ce45d345 Mon Sep 17 00:00:00 2001 From: BRAVO68WEB Date: Sat, 14 May 2022 14:34:49 +0530 Subject: [PATCH] Added Docs --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ package.json | 2 +- 2 files changed, 44 insertions(+), 1 deletion(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6c2fc50 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# Welcome to ciao-status-fetch 👋 +[![Version](https://img.shields.io/npm/v/ciao-status-fetch.svg)](https://www.npmjs.com/package/ciao-status-fetch) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](#) +[![Twitter: bravo68web](https://img.shields.io/twitter/follow/bravo68web.svg?style=social)](https://twitter.com/bravo68web) + +> A SDK to fetch data from Ciao instance + +## Install + +```sh +npm i ciao-status-fetch +``` + +## Usage + +```js +const ciaoInstance = require('./index.js') +const checker = new ciaoInstance("") + +const status = async () => { + await checker.check(); + }; + +``` + +## Run tests + +```sh +yarn run test +``` + +## Author + +👤 **BRAVO68WEB** + +* Website: https://bravo68web.me +* Twitter: [@bravo68web](https://twitter.com/bravo68web) +* Github: [@BRAVO68WEB](https://github.com/BRAVO68WEB) +* LinkedIn: [@bravo68web](https://linkedin.com/in/bravo68web) + +## Show your support + +Give a ⭐️ if this project helped you! \ No newline at end of file diff --git a/package.json b/package.json index 9b59cc5..0badcb2 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "ciao-status-fetch", - "version": "1.0.0", + "version": "1.0.1", "description": "A SDK to fetch data from Ciao instance", "main": "index.js", "author": "BRAVO68WEB",