Skip to content

Commit ae2e915

Browse files
committed
docs: update README with neutral technical framing and TF-Tech NV ownership
1 parent b231e46 commit ae2e915

1 file changed

Lines changed: 32 additions & 16 deletions

File tree

README.md

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,37 @@
55
[![Build](https://github.com/threefoldtech/tfgrid-sdk-ts/actions/workflows/build.yml/badge.svg)](https://github.com/threefoldtech/tfgrid-sdk-ts/actions/workflows/build.yml)
66
[![Code Coverage](https://codecov.io/gh/threefoldtech/tfgrid-sdk-ts/branch/development/graph/badge.svg)](https://codecov.io/gh/threefoldtech/tfgrid-sdk-ts)
77

8-
This repository contains the TypeScript SDK clients and tools for interacting with the ThreeFold Grid.
9-
10-
## Packages
11-
12-
- [stats](./packages/stats/README.md)
13-
- [grid client](./packages/grid_client/README.md)
14-
- [grid http server](./packages/grid_http_server/README.md)
15-
- [grid rmb server](./packages/grid_rmb_server/README.md)
16-
- [rmb direct client](./packages/rmb_direct_client/README.md)
17-
- [rmb peer client](./packages/rmb_peer_client/README.md)
18-
- [rmb peer server](./packages/rmb_peer_server/README.md)
19-
- [Playground](./packages/playground/README.md)
20-
- [graphql_client](./packages/graphql_client/README.md)
21-
- [gridproxy_client](./packages/gridproxy_client/README.md)
22-
- [UI](./packages/UI/README.md)
8+
TypeScript client libraries and utilities for interacting with the ThreeFold Grid from Node.js and browser environments. This SDK supports deployment management, wallet operations, peer-to-peer messaging, and grid querying through modern TypeScript APIs.
9+
10+
## What this is
11+
12+
This repository contains the official TypeScript SDK for the ThreeFold Grid. It provides a collection of packages that allow JavaScript and TypeScript applications running in Node.js or the browser to interact with grid services. The SDK covers everything from low-level chain and message-bus clients to high-level grid deployment helpers and user-interface components.
13+
14+
## What this repository contains
15+
16+
- [stats](./packages/stats/README.md) — Grid statistics collection and reporting.
17+
- [grid_client](./packages/grid_client/README.md) — Core client library for grid deployments and workload management.
18+
- [grid_http_server](./packages/grid_http_server/README.md) — HTTP server exposing grid client operations over a REST-like interface.
19+
- [grid_rmb_server](./packages/grid_rmb_server/README.md) — Server for handling Reliable Message Bus (RMB) communication.
20+
- [rmb_direct_client](./packages/rmb_direct_client/README.md) — Direct client for the RMB peer-to-peer message layer.
21+
- [rmb_peer_client](./packages/rmb_peer_client/README.md) — Peer client for RMB communication.
22+
- [rmb_peer_server](./packages/rmb_peer_server/README.md) — Peer server for RMB communication.
23+
- [Playground](./packages/playground/README.md) — Interactive web application for exploring and deploying grid workloads.
24+
- [graphql_client](./packages/graphql_client/README.md) — Client for the grid GraphQL API.
25+
- [gridproxy_client](./packages/gridproxy_client/README.md) — Client for the grid proxy API.
26+
- [UI](./packages/UI/README.md) — Reusable UI components for grid dashboards.
27+
28+
## Role in the stack
29+
30+
The SDK serves as the primary application-layer interface for JavaScript and TypeScript projects targeting the ThreeFold Grid. It wraps TFChain for on-chain operations, the grid proxy for node and contract queries, GraphQL for indexed data, and RMB for direct node communication. The packages in this repository power web-based dashboards, automation scripts, and backend Node.js services that need to provision or manage grid resources.
31+
32+
## Relation to ThreeFold
33+
34+
This technology is used within the ThreeFold ecosystem and was first deployed on the ThreeFold Grid. The component itself is designed as reusable infrastructure technology and should be understood by its technical function first, independent of any specific deployment.
35+
36+
## Ownership
37+
38+
This repository is owned and maintained by TF-Tech NV, a Belgian company responsible for the development and maintenance of this technology.
2339

2440
## Requirements
2541

@@ -61,4 +77,4 @@ export NODE_OPTIONS="--max-old-space-size=8192"
6177
## License
6278

6379
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
64-
Copyright (c) TFTech NV.
80+
Copyright (c) TF-Tech NV.

0 commit comments

Comments
 (0)