Added Docs
This commit is contained in:
parent
65b83a4afa
commit
73b7673d07
|
@ -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("<ciao-instance-url>")
|
||||
|
||||
const status = async () => {
|
||||
await checker.check(<id>);
|
||||
};
|
||||
|
||||
```
|
||||
|
||||
## 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!
|
|
@ -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",
|
||||
|
|
Loading…
Reference in New Issue