Skip to content

Commit 725c16f

Browse files
authored
Merge pull request #210 from Shopify/ap.update-readme
Update README
2 parents ea4d111 + 4c10021 commit 725c16f

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,36 @@
11
# Function Examples
22

3-
This is the home of all the public examples of Shopify Functions. It's used by the CLI when running `yarn shopify app scaffold extension`. Feel free to look around! Do not edit these files directly.
3+
This is the home of all the public examples of Shopify Functions. It's used by the CLI when running `yarn shopify app generate extension`. Feel free to look around! Do not edit these files directly.
44

55
## Local Development
66

7+
### Expand Liquid Templates
8+
79
If you wish to run the samples directly from this repository, you must first expand any `.liquid` templates with the following command.
810

911
```shell
1012
yarn
11-
yarn expand-liquid
12-
```
13+
yarn expand-liquid
14+
# optionally provide the language flavor
15+
yarn expand-liquid vanilla-js
16+
yarn expand-liquid typescript
17+
```
18+
19+
### Run Tests
20+
21+
```shell
22+
# JavaScript
23+
yarn test-js
24+
# TypeScript
25+
yarn test-ts
26+
# Rust
27+
cargo test
28+
```
29+
30+
### Lint
31+
32+
```shell
33+
# currently only applies to Rust
34+
cargo fmt
35+
cargo clippy -- -D warnings
36+
```

0 commit comments

Comments
 (0)