Skip to content

Commit e413498

Browse files
fix readme
Co-authored-by: itowlson <[email protected]> Signed-off-by: Karthik Ganeshram <[email protected]>
1 parent dbc78ae commit e413498

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ spin build --up
2727

2828
## Installing the template
2929

30-
The template can be installed using the following comman:
30+
You can install the template using the following command:
3131

3232
```bash
3333
spin templates install --git https://github.com/fermyon/spin-trigger-cron
3434
```
3535

36-
Once the template is installed, a new project can be instantiated using:
36+
Once the template is installed, you can create a new application using:
3737

3838
```bash
3939
spin new -t cron-rust hello_cron --accept-defaults
@@ -54,13 +54,13 @@ The following options are available to set in the [[trigger.cron]] section:
5454

5555
| Name | Type | Required? | Description |
5656
|-----------------------|------------------|-----------|-------------|
57-
| `component` | string or table | required | The component to run when a queue message is received. (This is the standard Spin trigger component field.) |
58-
| `cron_expression` | string | required | The `cron` expresison describing the interval at which the component is executed. |
57+
| `component` | string or table | required | The component to run on the schedule given in `cron_expression`. (This is the standard Spin trigger component field.) |
58+
| `cron_expression` | string | required | The `cron` expresison describing the schedule on which to execute the component. |
5959

6060
## Building Cron Components
6161

62-
Currently only a rust SDK is supported for guest components. The `spin-cron-sdk` along with the [`spin-sdk`](github.com/fermyon/spin) can be used to build cron components. The guest code must have a function decorated with the `#[cron_component]` macro. See `guest/src/lib.rs` for an example in rust.
62+
Currently only a Rust SDK is supported for guest components. The `spin-cron-sdk` along with the [`spin_sdk` crate](https://docs.rs/spin-sdk) can be used to build cron components. The guest code must have a function decorated with the `#[cron_component]` macro. See `guest/src/lib.rs` for an example in rust.
6363

6464
The signature of the function must be `fn handle_cron_event(metadata: Metadata) -> Result<(), Error>`.
6565

66-
The `Metadata` object contains a singular field `timestamp` which contains the duration since `00:00:00 UTC on 1 January 1970` (epoch) in seconds.
66+
The `Metadata` object contains a single field `timestamp` which contains the duration since 00:00:00 UTC on 1 January 1970 (the Unix epoch) in seconds.

0 commit comments

Comments
 (0)