Skip to content

Commit

Permalink
update name
Browse files Browse the repository at this point in the history
  • Loading branch information
t34-dev committed Aug 5, 2024
1 parent 501efaf commit c605d32
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 30 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/version.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: update_package_and_badges
name: update_version_on_tag

on:
push:
Expand Down Expand Up @@ -34,7 +34,7 @@ jobs:
- name: Update README.md badges
run: |
current_time=$(date +%s)
sed -i 's/\(v=\)[0-9]*/\1'"$current_time"'/g' README.md
sed -i 's/\(ver=\)[0-9]*/\1'"$current_time"'/g' README.md
- name: Commit changes
run: |
Expand Down
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
![TypeScript](https://img.shields.io/badge/TypeScript-5.5.3-blue?logo=typescript&v=1722517843)
![Node.js](https://img.shields.io/badge/Node.js-%3E%3D20-green?logo=node.js&v=1722517843)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/Well-do-it-too/ts-websocket-client?v=1722420610)
![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/Well-do-it-too/ts-websocket-client?sort=semver&style=flat&logo=git&logoColor=white&label=Latest%20Version&color=blue&v=1722517843)
![TypeScript](https://img.shields.io/badge/TypeScript-5.5.3-blue?logo=typescript&ver=1722420610)
![Node.js](https://img.shields.io/badge/Node.js-%3E%3D20-green?logo=node.js&ver=1722420610)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/t34-dev/ts-websocket-client?ver=1722420610)
![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/t34-dev/ts-websocket-client?sort=semver&style=flat&logo=git&logoColor=white&label=Latest%20Version&color=blue&ver=1722420610)

# TypeScript WebSocket Client

A robust and flexible WebSocket client implementation in TypeScript, designed for use in React, Node.js, and web projects.
Based on https://github.com/Well-do-it-too/ts-universal-package
Based on https://github.com/t34-dev/ts-universal-package

![TypeScript WebSocket Client Logo](./assets/example.png)

- [Demo](https://well-do-it-too.github.io/ts-websocket-client/)
- [Demo](https://t34-dev.github.io/ts-websocket-client/)

## Features

Expand All @@ -25,13 +25,13 @@ Based on https://github.com/Well-do-it-too/ts-universal-package
## Installation

```bash
npm install @well-do-it-too/ts-websocket-client
npm install @t34-dev/ts-websocket-client
```

or

```bash
yarn add @well-do-it-too/ts-websocket-client
yarn add @t34-dev/ts-websocket-client
```

## Usage
Expand All @@ -41,7 +41,7 @@ yarn add @well-do-it-too/ts-websocket-client
Here's a basic example of how to use the WebSocket client:

```typescript
import { WebSocketClient } from '@well-do-it-too/ts-websocket-client';
import { WebSocketClient } from '@t34-dev/ts-websocket-client';

const client = new WebSocketClient({
connectionName: 'MyConnection',
Expand All @@ -67,7 +67,7 @@ client.close();
Here's an example of how to use the WebSocket client in a Node.js environment:

```typescript
import { WebSocketClient } from '@well-do-it-too/ts-websocket-client';
import { WebSocketClient } from '@t34-dev/ts-websocket-client';

const client = new WebSocketClient({
connectionName: 'NodeConnection',
Expand Down Expand Up @@ -101,7 +101,7 @@ Here's an example of how to use the WebSocket client in a React component:

```tsx
import React, { useEffect, useState } from 'react';
import { WebSocketClient } from '@well-do-it-too/ts-websocket-client';
import { WebSocketClient } from '@t34-dev/ts-websocket-client';

const WebSocketComponent: React.FC = () => {
const [client, setClient] = useState<WebSocketClient | null>(null);
Expand Down Expand Up @@ -194,10 +194,10 @@ This project is licensed under the ISC License.

## Links

- [GitHub Repository](https://github.com/Well-do-it-too/ts-websocket-client)
- [npm Package](https://www.npmjs.com/package/@well-do-it-too/ts-websocket-client)
- [Demo](https://well-do-it-too.github.io/ts-websocket-client/)
- [GitHub Repository](https://github.com/t34-dev/ts-websocket-client)
- [npm Package](https://www.npmjs.com/package/@t34-dev/ts-websocket-client)
- [Demo](https://t34-dev.github.io/ts-websocket-client/)

---

Developed with ❤️ by [Well-do-it-too](https://github.com/Well-do-it-too)
Developed with ❤️ by [T34](https://github.com/t34-dev)
10 changes: 5 additions & 5 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,16 +73,16 @@ <h1>TypeScript WebSocket Client</h1>
<h3>Log:</h3>
<div id="log"></div>
<pre>wss://echo.websocket.org</pre>
<a href="https://github.com/Well-do-it-too/ts-websocket-client" target="_blank"
><small>https://github.com/Well-do-it-too/ts-websocket-client</small></a
<a href="https://github.com/t34-dev/ts-websocket-client" target="_blank"
><small>https://github.com/t34-dev/ts-websocket-client</small></a
>
<br />
<a href="https://www.npmjs.com/package/@well-do-it-too/ts-websocket-client" target="_blank"
><small>https://www.npmjs.com/package/@well-do-it-too/ts-websocket-client</small></a
<a href="https://www.npmjs.com/package/@t34-dev/ts-websocket-client" target="_blank"
><small>https://www.npmjs.com/package/@t34-dev/ts-websocket-client</small></a
>
</div>

<script src="https://unpkg.com/@well-do-it-too/ts-websocket-client"></script>
<script src="https://unpkg.com/@t34-dev/ts-websocket-client"></script>
<script>
let client = new tsWebsocketClient.WebSocketClient({
connectionName: 'TestConnection',
Expand Down
8 changes: 4 additions & 4 deletions example/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,12 @@ <h1>TypeScript WebSocket Client</h1>
<h3>Log:</h3>
<div id="log"></div>
<pre>wss://echo.websocket.org</pre>
<a href="https://github.com/Well-do-it-too/ts-websocket-client" target="_blank"
><small>https://github.com/Well-do-it-too/ts-websocket-client</small></a
<a href="https://github.com/t34-dev/ts-websocket-client" target="_blank"
><small>https://github.com/t34-dev/ts-websocket-client</small></a
>
<br />
<a href="https://www.npmjs.com/package/@well-do-it-too/ts-websocket-client" target="_blank"
><small>https://www.npmjs.com/package/@well-do-it-too/ts-websocket-client</small></a
<a href="https://www.npmjs.com/package/@t34-dev/ts-websocket-client" target="_blank"
><small>https://www.npmjs.com/package/@t34-dev/ts-websocket-client</small></a
>
</div>

Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@well-do-it-too/ts-websocket-client",
"name": "@t34-dev/ts-websocket-client",
"version": "1.0.7",
"description": "Robust TypeScript WebSocket client with auto-reconnection for React, Node.js, and web projects. Supports event handling and connection management.",
"main": "dist/index.js",
Expand Down Expand Up @@ -43,15 +43,15 @@
"license": "ISC",
"repository": {
"type": "git",
"url": "https://github.com/Well-do-it-too/ts-websocket-client.git"
"url": "https://github.com/t34-dev/ts-websocket-client.git"
},
"bugs": {
"url": "https://github.com/Well-do-it-too/ts-websocket-client/issues"
"url": "https://github.com/t34-dev/ts-websocket-client/issues"
},
"publishConfig": {
"access": "public"
},
"homepage": "https://well-do-it-too.github.io/ts-websocket-client/",
"homepage": "https://t34-dev.github.io/ts-websocket-client/",
"devDependencies": {
"@rollup/plugin-alias": "^5.1.0",
"@rollup/plugin-commonjs": "^22.0.0",
Expand Down

0 comments on commit c605d32

Please sign in to comment.