janis/react-teamspeak-remote-app-api
1
0
Fork 0
mirror of https://github.com/DerTyp7/react-teamspeak-remote-app-api.git synced 2025-10-29 04:42:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

update README and package.json for TeamSpeak5/6 API naming consistency

Browse Source
This commit is contained in:
Janis
2025-01-24 13:30:39 +01:00
parent 798dfd8ec5
commit ff9e2a3284
2 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -1,18 +1,18 @@
# React TeamSpeak5 RemoteApp API # React TeamSpeak5/6 RemoteApp API
[![npm](https://img.shields.io/npm/v/react-ts5-remote-app-api.svg)](https://www.npmjs.com/package/react-ts5-remote-app-api) ![downloads](https://img.shields.io/npm/dt/react-ts5-remote-app-api.svg) [![npm](https://img.shields.io/npm/v/react-ts5-remote-app-api.svg)](https://www.npmjs.com/package/react-ts5-remote-app-api) ![downloads](https://img.shields.io/npm/dt/react-ts5-remote-app-api.svg)
This is a ReactJS hook for the TeamSpeak5 RemoteApp API. This is a ReactJS hook for the TeamSpeak5/6 RemoteApp API.
It gathers all the events and methods from the API and makes them available as React states. It gathers all the events and methods from the API and makes them available as React states.
Please note that this is still a work in progress and not all events and methods are implemented yet. Please note that this is still a work in progress and not all events and methods are implemented yet.
Projects which are using this hook: [TS5 OBS Overlay](https://github.com/DerTyp7/ts5-obs-overlay) Projects which are using this hook: [TeamSpeak OBS Overlay](https://github.com/DerTyp7/ts5-obs-overlay)
## Table of Contents ## Table of Contents
- [React TeamSpeak5 RemoteApp API](#react-teamspeak5-remoteapp-api) - [React TeamSpeak5/6 RemoteApp API](#react-teamspeak56-remoteapp-api)
- [Table of Contents](#table-of-contents) - [Table of Contents](#table-of-contents)
- [Installation](#installation) - [Installation](#installation)
- [Usage](#usage) - [Usage](#usage)
@@ -26,13 +26,13 @@ Projects which are using this hook: [TS5 OBS Overlay](https://github.com/DerTyp7
## Installation ## Installation
```bash ```bash
npm install react-ts5-remote-app-api npm install react-teamspeak-remote-app-api
``` ```
## Usage ## Usage
```Typescript ```Typescript
import useTSRemoteApp, { IClient } from "react-ts5-remote-app-api"; import useTSRemoteApp, { IClient } from "react-teamspeak-remote-app-api";
export default function App() { export default function App() {
const { const {
@@ -57,7 +57,7 @@ export default function App() {
### Get all clients in the current channel ### Get all clients in the current channel
```Typescript ```Typescript
import useTSRemoteApp, { IClient } from "react-ts5-remote-app-api"; import useTSRemoteApp, { IClient } from "react-teamspeak-remote-app-api";
default function App() { default function App() {
const { clientsInChannel } = useTSRemoteApp({ const { clientsInChannel } = useTSRemoteApp({

6
package.json
View File

@@ -1,7 +1,7 @@
{ {
"name": "react-ts5-remote-app-api", "name": "react-teamspeak-remote-app-api",
"version": "2.0.0", "version": "2.0.0",
"description": "React hook/api for the TeamSpeak5 remote app feature", "description": "React hook/api for the TeamSpeak5/6 remote app feature",
"main": "dist/cjs/index.js", "main": "dist/cjs/index.js",
"module": "dist/esm/index.js", "module": "dist/esm/index.js",
"source": "src/index.ts", "source": "src/index.ts",
@@ -27,7 +27,7 @@
"author": "DerTyp7", "author": "DerTyp7",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/DerTyp7/react-ts5-remote-app-api" "url": "https://github.com/DerTyp7/react-teamspeak-remote-app-api"
}, },
"license": "ISC", "license": "ISC",
"peerDependencies": { "peerDependencies": {