Skip to content

Commit adcd97e

Browse files
committed
add readme to top level and all packages
Signed-off-by: karthik2804 <[email protected]>
1 parent 0e6bb67 commit adcd97e

File tree

12 files changed

+51
-1
lines changed

12 files changed

+51
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,21 @@ Please file an issue if you have any trouble.
6161

6262
See the [examples directory](https://github.com/fermyon/spin-js-sdk/tree/main/examples) in the repository for more examples.
6363

64-
To learn more about the JS SDK checkout the [documentation](https://developer.fermyon.com/spin/v2/javascript-components)
64+
To learn more about the JS SDK checkout the [documentation](https://developer.fermyon.com/spin/v2/javascript-components)
65+
66+
## Structure of this repository
67+
68+
This repository contains multiple packages under the [`packages/`](./packages/) directory. Each pacakge contains that contains a `spin-` prefix hosts modules that can be used to enable access to the various Spin interfaces. There are other kind of packages as well, namely triggers and `build-tools`.
69+
70+
The `examples` directory contains various examples of common patterns and using popular SDKs.
71+
72+
The `templates` directory contains all the Spin templates. It currently has four templates - `http-js`, `http-rs`, redis-js` and `redis-ts`.
73+
74+
## Testing the packages together (integration testing)
75+
76+
There is a test script [(`test.sh`)](./test/test.sh) that builds and runs a Spin app which tests itself for various functionalities by making fetch requests to various endpoints. To run:
77+
78+
```bash
79+
cd test
80+
./test.sh
81+
``

packages/http-trigger/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Wasi HTTP Proxy
2+
3+
This package enables adding the `wasi:http` trigger export to apps built using the `@spinframework/build-tools`. This repository does not contain any code, it just contains the `wit` files describing the `wasi/http` world.

packages/spin-kv/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Spin KV
2+
3+
This package provides bindings that enables using the Spin Key Value interface in apps built using the `@spinframework/build-tools`.

packages/spin-llm/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Spin LLM
2+
3+
This package provides bindings that enables using the Spin LLM interface in apps built using the `@spinframework/build-tools`.

packages/spin-mqtt/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Spin MQTT
2+
3+
This package provides bindings that enables using the Spin MQTT interface in apps built using the `@spinframework/build-tools`.

packages/spin-mysql/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Spin Mysql
2+
3+
This package provides bindings that enables using the Spin Mysql interface in apps built using the `@spinframework/build-tools`.

packages/spin-postgres/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Spin Postgres
2+
3+
This package provides bindings that enables using the Spin Postgres interface in apps built using the `@spinframework/build-tools`.

packages/spin-postgres3/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Spin Postgres v3
2+
3+
This package provides bindings that enables using the Spin Postgres v3 interface in apps built using the `@spinframework/build-tools`.

packages/spin-redis/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Spin Redis
2+
3+
This package provides bindings that enables using the Spin redis interface in apps built using the `@spinframework/build-tools`.

packages/spin-sqlite/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Spin Sqlite
2+
3+
This package provides bindings that enables using the Spin Sqlite interface in apps built using the `@spinframework/build-tools`.

0 commit comments

Comments
 (0)