Skip to content

Commit dc14a9a

Browse files
publish to default npm registry
1 parent 3fb6943 commit dc14a9a

6 files changed

Lines changed: 18 additions & 54 deletions

File tree

.github/workflows/publish.yml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ jobs:
1515
- uses: actions/setup-node@v4
1616
with:
1717
node-version: '20.x'
18-
registry-url: 'https://npm.pkg.github.com'
19-
scope: '@marketrix-ai'
18+
registry-url: 'https://registry.npmjs.org'
2019

2120
- name: Install dependencies
2221
run: |
@@ -41,9 +40,9 @@ jobs:
4140
- name: Publish Client
4241
run: cd client && npm publish
4342
env:
44-
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
43+
NODE_AUTH_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}
4544

4645
- name: Publish Server
4746
run: cd server && npm publish
4847
env:
49-
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
48+
NODE_AUTH_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}

README.md

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,20 @@ This repository contains the TypeScript implementations for the Link protocol, a
44

55
## Packages
66

7-
- **[@marketrix-ai/link-server](./server)**: The server-side library.
8-
- **[@marketrix-ai/link-client](./client)**: The client-side library.
7+
- **[@marketrix.ai/link-server](./server)**: The server-side library.
8+
- **[@marketrix.ai/link-client](./client)**: The client-side library.
99

1010
## Getting Started
1111

12-
To install these packages, you must configure your npm client to use the GitHub Package Registry for the `@marketrix-ai` scope.
12+
To install these packages, you must configure your npm client to use the GitHub Package Registry for the `@marketrix.ai` scope.
1313

14-
### 1. Configure Authentication
14+
### Install
1515

16-
Create or update an `.npmrc` file in your project root or user home directory (`~/.npmrc`) with the following content:
17-
18-
```ini
19-
@marketrix-ai:registry=https://npm.pkg.github.com
20-
//npm.pkg.github.com/:_authToken=YOUR_GITHUB_PAT
21-
```
22-
23-
Replace `YOUR_GITHUB_PAT` with a GitHub Personal Access Token that has `read:packages` scope.
24-
25-
### 2. Install
26-
27-
Once configured, you can install the packages as usual:
16+
You can install the packages from npm:
2817

2918
```bash
30-
npm install @marketrix-ai/link-server
31-
npm install @marketrix-ai/link-client
19+
npm install @marketrix.ai/link-server
20+
npm install @marketrix.ai/link-client
3221
```
3322

3423
## Documentation

client/README.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,13 @@ This is the client-side library for the Link protocol. It allows you to connect
55
## Installation
66

77
```bash
8-
npm install @marketrix-ai/link-client
8+
npm install @marketrix.ai/link-client
99
```
1010

11-
**Note**: You need to configure your `.npmrc` to install packages from the GitHub registry.
12-
13-
### Configuration (`.npmrc`)
14-
15-
Add the following to your `.npmrc` file (either in your project root or user home directory):
16-
17-
```
18-
@marketrix-ai:registry=https://npm.pkg.github.com
19-
```
20-
21-
You will also need to authenticate with GitHub Packages using a Personal Access Token (PAT).
22-
2311
## Usage
2412

2513
```typescript
26-
import { Client } from '@marketrix-ai/link-client';
14+
import { Client } from '@marketrix.ai/link-client';
2715

2816
const client = new Client({
2917
url: 'ws://localhost:8080',

client/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
2-
"name": "@marketrix-ai/link-client",
2+
"name": "@marketrix.ai/link-client",
33
"version": "0.0.0",
44
"description": "",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",
77
"publishConfig": {
8-
"registry": "https://npm.pkg.github.com"
8+
"access": "public"
99
},
1010
"repository": {
1111
"type": "git",

server/README.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,17 @@ This is the server-side library for the Link protocol. It provides a WebSocket s
55
## Installation
66

77
```bash
8-
npm install @marketrix-ai/link-server
8+
npm install @marketrix.ai/link-server
99
```
1010

11-
**Note**: You need to configure your `.npmrc` to install packages from the GitHub registry.
12-
13-
### Configuration (`.npmrc`)
14-
15-
Add the following to your `.npmrc` file (either in your project root or user home directory):
16-
17-
```
18-
@marketrix-ai:registry=https://npm.pkg.github.com
19-
```
20-
21-
You will also need to authenticate with GitHub Packages using a Personal Access Token (PAT).
22-
2311
## Usage
2412

2513
You can use the `LinkServer` class to create a WebSocket server or integrate it into an existing application.
2614

2715
### Basic Usage
2816

2917
```typescript
30-
import { LinkServer } from '@marketrix-ai/link-server';
18+
import { LinkServer } from '@marketrix.ai/link-server';
3119

3220
const server = new LinkServer({ port: 8080 });
3321

server/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
2-
"name": "@marketrix-ai/link-server",
2+
"name": "@marketrix.ai/link-server",
33
"version": "0.0.0",
44
"description": "",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",
77
"publishConfig": {
8-
"registry": "https://npm.pkg.github.com"
8+
"access": "public"
99
},
1010
"repository": {
1111
"type": "git",

0 commit comments

Comments
 (0)