Skip to content

Commit

Permalink
Doc sweep
Browse files Browse the repository at this point in the history
  • Loading branch information
ThetaSinner committed Mar 7, 2024
1 parent fefcad3 commit b28ad06
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ jobs:
- name: Check scripts
run: |
nix develop --command bash -c "shellcheck scripts/*.sh"
nix develop --command bash -c "shellcheck scripts/*.sh"
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ For example, see the [zome_call_single_value](https://github.com/holochain/wind-

### Developer guide (for wind-tunnel)

There is a Nix environment provided and it is recommended that you use its shell for development:
There is a Nix environment provided, and it is recommended that you use its shell for development:

```bash
nix develop
Expand Down
12 changes: 12 additions & 0 deletions scenarios/single_write_many_read/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## single_write_many_read

### Description

Creates an entry in the agent setup, then the agent behaviour is to read the record back. This tests the maximum read
performance for reading back local data when the chain is short.

### Suggested command

```bash
RUST_LOG=info cargo run --package single_write_many_read -- --connection-string ws://localhost:8888 --duration 300
```
4 changes: 2 additions & 2 deletions scenarios/zome_call_single_value/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
Calls a zome function that returns a fixed value. This tests the maximum performance of zome calls when the zome
function is not calling into Holochain other otherwise doing any work.

### Suggested run
### Suggested command

```bash
RUST_LOG=info cargo run --package zome_call_single_value -- --connection-string ws://localhost:8888 --duration 900
RUST_LOG=info cargo run --package zome_call_single_value -- --connection-string ws://localhost:8888 --duration 300
```

0 comments on commit b28ad06

Please sign in to comment.