Skip to content
This repository was archived by the owner on Aug 2, 2026. It is now read-only.

Commit ff9e2a3

Browse files
committed
update README and package.json for TeamSpeak5/6 API naming consistency
1 parent 798dfd8 commit ff9e2a3

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# React TeamSpeak5 RemoteApp API
1+
# React TeamSpeak5/6 RemoteApp API
22

33
[![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)
44

5-
This is a ReactJS hook for the TeamSpeak5 RemoteApp API.
5+
This is a ReactJS hook for the TeamSpeak5/6 RemoteApp API.
66

77
It gathers all the events and methods from the API and makes them available as React states.
88

99
Please note that this is still a work in progress and not all events and methods are implemented yet.
1010

11-
Projects which are using this hook: [TS5 OBS Overlay](https://github.com/DerTyp7/ts5-obs-overlay)
11+
Projects which are using this hook: [TeamSpeak OBS Overlay](https://github.com/DerTyp7/ts5-obs-overlay)
1212

1313
## Table of Contents
1414

15-
- [React TeamSpeak5 RemoteApp API](#react-teamspeak5-remoteapp-api)
15+
- [React TeamSpeak5/6 RemoteApp API](#react-teamspeak56-remoteapp-api)
1616
- [Table of Contents](#table-of-contents)
1717
- [Installation](#installation)
1818
- [Usage](#usage)
@@ -26,13 +26,13 @@ Projects which are using this hook: [TS5 OBS Overlay](https://github.com/DerTyp7
2626
## Installation
2727

2828
```bash
29-
npm install react-ts5-remote-app-api
29+
npm install react-teamspeak-remote-app-api
3030
```
3131

3232
## Usage
3333

3434
```Typescript
35-
import useTSRemoteApp, { IClient } from "react-ts5-remote-app-api";
35+
import useTSRemoteApp, { IClient } from "react-teamspeak-remote-app-api";
3636

3737
export default function App() {
3838
const {
@@ -57,7 +57,7 @@ export default function App() {
5757
### Get all clients in the current channel
5858

5959
```Typescript
60-
import useTSRemoteApp, { IClient } from "react-ts5-remote-app-api";
60+
import useTSRemoteApp, { IClient } from "react-teamspeak-remote-app-api";
6161

6262
default function App() {
6363
const { clientsInChannel } = useTSRemoteApp({

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "react-ts5-remote-app-api",
2+
"name": "react-teamspeak-remote-app-api",
33
"version": "2.0.0",
4-
"description": "React hook/api for the TeamSpeak5 remote app feature",
4+
"description": "React hook/api for the TeamSpeak5/6 remote app feature",
55
"main": "dist/cjs/index.js",
66
"module": "dist/esm/index.js",
77
"source": "src/index.ts",
@@ -27,7 +27,7 @@
2727
"author": "DerTyp7",
2828
"repository": {
2929
"type": "git",
30-
"url": "https://github.com/DerTyp7/react-ts5-remote-app-api"
30+
"url": "https://github.com/DerTyp7/react-teamspeak-remote-app-api"
3131
},
3232
"license": "ISC",
3333
"peerDependencies": {

0 commit comments

Comments
 (0)