mirror of
https://github.com/DeBrosOfficial/network-ts-sdk.git
synced 2025-12-11 01:58:49 +00:00
Increment version to 0.1.5 and update package name references in README.md to '@debros/network-ts-sdk'; remove GitHub Actions workflow for GitHub Packages publishing
This commit is contained in:
parent
9d9f64c11e
commit
f2d8d35a35
27
.github/workflows/publish-npm.yml
vendored
27
.github/workflows/publish-npm.yml
vendored
@ -30,30 +30,3 @@ jobs:
|
|||||||
run: npm publish --access public
|
run: npm publish --access public
|
||||||
env:
|
env:
|
||||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||||
|
|
||||||
publish-github:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
packages: write
|
|
||||||
steps:
|
|
||||||
- name: Checkout code
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Setup Node.js for GitHub Packages
|
|
||||||
uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version: '18'
|
|
||||||
registry-url: 'https://npm.pkg.github.com'
|
|
||||||
scope: '@debros'
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: npm install --frozen-lockfile
|
|
||||||
|
|
||||||
- name: Build SDK
|
|
||||||
run: npm run build
|
|
||||||
|
|
||||||
- name: Publish to GitHub Packages
|
|
||||||
run: npm publish
|
|
||||||
env:
|
|
||||||
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
|
|||||||
12
README.md
12
README.md
@ -1,4 +1,4 @@
|
|||||||
# @network/sdk - TypeScript SDK for DeBros Network
|
# @debros/network-ts-sdk - TypeScript SDK for DeBros Network
|
||||||
|
|
||||||
A modern, isomorphic TypeScript SDK for the DeBros Network gateway. Works seamlessly in both Node.js and browser environments with support for database operations, pub/sub messaging, and network management.
|
A modern, isomorphic TypeScript SDK for the DeBros Network gateway. Works seamlessly in both Node.js and browser environments with support for database operations, pub/sub messaging, and network management.
|
||||||
|
|
||||||
@ -14,7 +14,7 @@ A modern, isomorphic TypeScript SDK for the DeBros Network gateway. Works seamle
|
|||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install @network/network-ts-sdk
|
npm install @debros/network-ts-sdk
|
||||||
```
|
```
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
@ -22,7 +22,7 @@ npm install @network/network-ts-sdk
|
|||||||
### Initialize the Client
|
### Initialize the Client
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { createClient } from "@network/sdk";
|
import { createClient } from "@debros/network-ts-sdk";
|
||||||
|
|
||||||
const client = createClient({
|
const client = createClient({
|
||||||
baseURL: "http://localhost:6001",
|
baseURL: "http://localhost:6001",
|
||||||
@ -234,7 +234,7 @@ interface ClientConfig {
|
|||||||
By default, credentials are stored in memory. For browser apps, use localStorage:
|
By default, credentials are stored in memory. For browser apps, use localStorage:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { createClient, LocalStorageAdapter } from "@network/sdk";
|
import { createClient, LocalStorageAdapter } from "@debros/network-ts-sdk";
|
||||||
|
|
||||||
const client = createClient({
|
const client = createClient({
|
||||||
baseURL: "http://localhost:6001",
|
baseURL: "http://localhost:6001",
|
||||||
@ -248,7 +248,7 @@ const client = createClient({
|
|||||||
The SDK throws `SDKError` for all errors:
|
The SDK throws `SDKError` for all errors:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { SDKError } from "@network/sdk";
|
import { SDKError } from "@debros/network-ts-sdk";
|
||||||
|
|
||||||
try {
|
try {
|
||||||
await client.db.query("SELECT * FROM nonexistent");
|
await client.db.query("SELECT * FROM nonexistent");
|
||||||
@ -268,7 +268,7 @@ The SDK works in browsers with minimal setup:
|
|||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Browser example
|
// Browser example
|
||||||
import { createClient } from "@network/sdk";
|
import { createClient } from "@debros/network-ts-sdk";
|
||||||
|
|
||||||
const client = createClient({
|
const client = createClient({
|
||||||
baseURL: "https://gateway.example.com",
|
baseURL: "https://gateway.example.com",
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@debros/network-ts-sdk",
|
"name": "@debros/network-ts-sdk",
|
||||||
"version": "0.1.4",
|
"version": "0.1.5",
|
||||||
"description": "TypeScript SDK for DeBros Network Gateway",
|
"description": "TypeScript SDK for DeBros Network Gateway",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"main": "./dist/index.js",
|
"main": "./dist/index.js",
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user