Skip to content

Commit

Permalink
chore:readme
Browse files Browse the repository at this point in the history
  • Loading branch information
apoorvcodes committed Jan 28, 2022
1 parent 6734a91 commit c9e404f
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 6 deletions.
12 changes: 6 additions & 6 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"workbench.colorCustomizations": {
"activityBar.background": "#342D0E",
"titleBar.activeBackground": "#493F13",
"titleBar.activeForeground": "#FCFBF5"
}
}
"workbench.colorCustomizations": {
"activityBar.background": "#342D0E",
"titleBar.activeBackground": "#493F13",
"titleBar.activeForeground": "#FCFBF5"
}
}
69 changes: 69 additions & 0 deletions README.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Amethyste Client

<img align="center" src="https://api.amethyste.moe/d983cbfa8bf6413d79bf52ae6c545e25.png">

### An unofficial wrapper for [Amethyste-Api](https://api.amethyste.moe/) written in TypeScript


## ⚙️ Setup

```bash
//yarn
yarn add amethyste-client

//npm
npm i amethyste-client
```

## 📑 Usage

#### Note : You can get your api key [here](https://api.amethyste.moe/)
<br>

### JavaScript
```js

const amiapi = require("amethyste-client")

const Client = amiapi("UR_TOKEN")

Client.generate({
endpoint: "beautiful",
options: {
"url": client.user.avatarURL
}
}).then(img => {
console.log(img)
})
```


### TypeScript
```ts

import amiapi from "amethyste-client"

const Client:amiapi = amiapi("UR_TOKEN")

Client.generate({
endpoint: "beautiful",
options: {
"url": client.user.avatarURL
}
}).then(img => {
console.log(img)
})
```

### Response

```json
{
"status": 200,
"url": "https://cdn.amethyste.moe/wallpaper14ebdfb3f9a9e4025b54ab759f1ad9e60bd0.jpg"
}
```

## 🧾 Endpoints

#### For endpoints and options kindly refer here at the [docs](https://docs.api.amethyste.moe/)

0 comments on commit c9e404f

Please sign in to comment.