Skip to content

Commit 0dad50b

Browse files
committed
refactor README.md
1 parent 413b963 commit 0dad50b

File tree

2 files changed

+44
-8
lines changed

2 files changed

+44
-8
lines changed

README.md

Lines changed: 42 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,51 @@
1-
# **@squarecloud/api**
1+
<div align="center">
2+
<img alt="Square Cloud Banner" src="https://cdn.squarecloud.app/png/github-readme.png">
3+
</div>
24

3-
## **Instalação**
5+
<h1 align="center">@squarecloud/api</h1>
6+
7+
<p align="center">A NodeJS SDK for consuming the <a href="https://squarecloud.app" target="_blank">Square Cloud</a> API.</p>
8+
9+
<div align="center">
10+
<div style="width: fit-content; display: flex; align-items: flex-start; gap: 4px;">
11+
<img alt="NPM License" src="https://img.shields.io/npm/l/@squarecloud/api">
12+
<img alt="NPM Downloads" src="https://img.shields.io/npm/dw/@squarecloud/api">
13+
<a href="https://npmjs.com/package/@squarecloud/api">
14+
<img alt="NPM Version" src="https://img.shields.io/npm/v/@squarecloud/api">
15+
</a>
16+
</div>
17+
</div>
18+
19+
## Installation
420

521
```bash
622
npm install @squarecloud/api
23+
// or
24+
yarn add @squarecloud/api
25+
// or
26+
pnpm add @squarecloud/api
27+
```
28+
29+
## Documentation
30+
31+
Visit our [official documentation](https://docs.squarecloud.app/sdks/js/) for more information about how to use this library.
32+
33+
## Getting Started
34+
35+
```ts
36+
import { SquareCloudAPI } from "@squarecloud/api"
37+
// const { SquareCloudAPI } = require("@squarecloud/api");
38+
39+
const api = new SquareCloudAPI("Your API Key")
40+
const user = await api.users.get()
41+
const application = user.applications.get("Application ID")
742
```
843

9-
## **Documentação**
44+
## Contributing
1045

11-
Acesse nossa [documentação oficial](https://docs.squarecloud.app/sdks/js/client) para mais informações sobre como utilizar a livraria!
46+
Feel free to contribute with suggestions or bug reports at our [GitHub repository](https://github.com/squarecloudofc/wrapper-api-js).
1247

13-
## **Contribuição**
48+
## Authors
1449

15-
Sinta se à vontade para contribuir e reportar falhas no nosso [repositório do GitHub](https://github.com/squarecloudofc/wrapper-api-js).
50+
- [@joaotonaco](https://github.com/joaotonaco)
51+
- [@joaootavios](https://github.com/joaootavios)

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)