mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-09 20:47:47 +00:00
Delete readme.md
This commit is contained in:
49
readme.md
49
readme.md
@@ -1,49 +0,0 @@
|
|||||||
# Plex API Client
|
|
||||||
|
|
||||||
[](https://discord.gg/HQTPSJnWhb)
|
|
||||||
[](https://npmjs.com/package/@lukehagar/plexjs)
|
|
||||||
[](https://GitHub.com/LukeHagar/plexjs/tags/)
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
A typescript sdk for interacting with Plex.tv and Plex Media Server REST API's.
|
|
||||||
|
|
||||||
Documentation for all of the available endpoints [can be found here](https://plexapi.dev/docs/plex)
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
npm
|
|
||||||
```bash
|
|
||||||
npm install @lukehagar/plexjs
|
|
||||||
```
|
|
||||||
|
|
||||||
yarn
|
|
||||||
```bash
|
|
||||||
yarn add @lukehagar/plexjs
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
import {
|
|
||||||
Configuration,
|
|
||||||
ServerApi,
|
|
||||||
DevicesApi,
|
|
||||||
UserApi,
|
|
||||||
} from "@lukehagar/plexjs";
|
|
||||||
import dotenv from "dotenv";
|
|
||||||
dotenv.config();
|
|
||||||
|
|
||||||
const config = new Configuration({
|
|
||||||
basePath: process.env.BASE_PATH,
|
|
||||||
plexToken: process.env.PLEX_TOKEN,
|
|
||||||
});
|
|
||||||
|
|
||||||
new ServerApi(config).getServerCapabilities().then((resp) => console.log(resp));
|
|
||||||
|
|
||||||
new DevicesApi(config).getDevices().then((resp) => console.log(resp));
|
|
||||||
|
|
||||||
new UserApi(config).getUserDetails().then((resp) => console.log(resp));
|
|
||||||
```
|
|
||||||
Reference in New Issue
Block a user