Skip to content

Commit 09c9e2d

Browse files
committed
Update README.md
1 parent 4b29168 commit 09c9e2d

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -528,15 +528,15 @@ Feel free to fork this project. We will happily merge bug fixes or other small
528528
improvements. For bigger changes you should probably get in touch with us
529529
before you start to avoid not seeing them merged.
530530
531-
## Testing
531+
### Testing
532532
533-
### Basic Tests
533+
#### Basic Tests
534534
535535
```bash
536536
make test
537537
```
538538
539-
### System Tests
539+
#### System Tests
540540
541541
System tests require:
542542
@@ -553,15 +553,14 @@ Then run:
553553
make test-all
554554
```
555555
556-
### Node.js Comparison Test
556+
#### Node.js Reference Implementation Parity Assertions
557557
558-
The SDK includes a test that compares URL signing with our reference Node.js implementation. To run this test:
558+
The SDK includes assertions that compare URL signing with our reference Node.js implementation. To run these tests:
559559
560560
1. Requirements:
561561
562562
- Node.js installed
563563
- tsx installed globally (`npm install -g tsx`)
564-
- Valid Transloadit credentials in environment
565564
566565
2. Install dependencies:
567566
@@ -577,9 +576,9 @@ export TRANSLOADIT_SECRET='your-auth-secret'
577576
TEST_NODE_PARITY=1 make test-all
578577
```
579578
580-
This test is opt-in and not run by default locally. In CI this is opted-into.
579+
CI opts-into `TEST_NODE_PARITY=1`, and you can optionally do this locally as well.
581580
582-
## Versioning
581+
### Versioning
583582
584583
This project implements the Semantic Versioning guidelines.
585584
@@ -595,7 +594,7 @@ And constructed with the following guidelines:
595594
596595
For more information on SemVer, please visit http://semver.org/.
597596
598-
## Releasing a new version
597+
### Releasing a new version
599598
600599
```bash
601600
# 1. update CHANGELOG.md

0 commit comments

Comments
 (0)