Skip to content

Commit 7e6c826

Browse files
Cleanup readmes
Co-authored-by: Till Schneidereit <[email protected]>
1 parent adcd97e commit 7e6c826

File tree

11 files changed

+15
-13
lines changed

11 files changed

+15
-13
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,9 @@ To learn more about the JS SDK checkout the [documentation](https://developer.fe
6565

6666
## Structure of this repository
6767

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`.
68+
This repository contains multiple packages under the [`packages/`](./packages/) directory. Packages whose names start with `spin-` host provide access to Spin-specific interfaces, whereas the `http-trigger` package can be used for creating runtime-agnostic components that just rely on `wasi:[email protected]`.
69+
70+
The `build-tools` package provides the tools for componentizing JavaScript/TypeScript source code, regardless of the interfaces used.
6971

7072
The `examples` directory contains various examples of common patterns and using popular SDKs.
7173

packages/build-tools/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Options:
1919
-d, --debug Enable JavaScript debugging [boolean]
2020
```
2121

22-
**Note:** The input source should be Javascript.
22+
**Note:** The input source must be JavaScript. Use `tsc` or a bundler to first translate source code in TypeScript or other languages.
2323

2424
#### `wit-tools` crate
2525

packages/build-tools/crates/wit-tools/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The `wit` world that the library implements is defined in the [`wit` directory](
1212

1313
### Building
1414

15-
The component can be build by running
15+
The component can be built by running
1616

1717
```bash
1818
cargo build --release

packages/http-trigger/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Wasi HTTP Proxy
22

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.
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` package.

packages/spin-kv/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Spin KV
22

3-
This package provides bindings that enables using the Spin Key Value interface in apps built using the `@spinframework/build-tools`.
3+
This package provides bindings that enable using the Spin Key-Value interface in apps built using the `@spinframework/build-tools`.

packages/spin-llm/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Spin LLM
22

3-
This package provides bindings that enables using the Spin LLM interface in apps built using the `@spinframework/build-tools`.
3+
This package provides bindings that enable using the Spin LLM interface in apps built using the `@spinframework/build-tools`.

packages/spin-mqtt/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Spin MQTT
22

3-
This package provides bindings that enables using the Spin MQTT interface in apps built using the `@spinframework/build-tools`.
3+
This package provides bindings that enable using the Spin MQTT interface in apps built using the `@spinframework/build-tools`.

packages/spin-mysql/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# Spin Mysql
1+
# Spin MySQL
22

3-
This package provides bindings that enables using the Spin Mysql interface in apps built using the `@spinframework/build-tools`.
3+
This package provides bindings that enable using the Spin MySQL interface in apps built using the `@spinframework/build-tools`.

packages/spin-postgres/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Spin Postgres
22

3-
This package provides bindings that enables using the Spin Postgres interface in apps built using the `@spinframework/build-tools`.
3+
This package provides bindings that enable using the Spin Postgres interface in apps built using the `@spinframework/build-tools`.

packages/spin-postgres3/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Spin Postgres v3
22

3-
This package provides bindings that enables using the Spin Postgres v3 interface in apps built using the `@spinframework/build-tools`.
3+
This package provides bindings that enable using the Spin Postgres v3 interface in apps built using the `@spinframework/build-tools`.

0 commit comments

Comments
 (0)