From 6eaf9ce4488eab329906d1453bfdf14ef6a74acf Mon Sep 17 00:00:00 2001 From: Luke Hagar Date: Thu, 26 Oct 2023 21:15:11 -0500 Subject: [PATCH] Delete readme.md --- readme.md | 49 ------------------------------------------------- 1 file changed, 49 deletions(-) delete mode 100644 readme.md diff --git a/readme.md b/readme.md deleted file mode 100644 index 8510c70b..00000000 --- a/readme.md +++ /dev/null @@ -1,49 +0,0 @@ -# Plex API Client - -[![Discord](https://img.shields.io/discord/1095524608406474802?style=social&logo=discord)](https://discord.gg/HQTPSJnWhb) -[![Npm package monthly downloads](https://badgen.net/npm/dm/@lukehagar/plexjs)](https://npmjs.com/package/@lukehagar/plexjs) -[![GitHub tag](https://img.shields.io/github/tag/LukeHagar/plexjs.svg)](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)); -```