diff options
Diffstat (limited to 'grasp-audit/QUICK_START.md')
| -rw-r--r-- | grasp-audit/QUICK_START.md | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/grasp-audit/QUICK_START.md b/grasp-audit/QUICK_START.md index d4ee494..cb6d8a7 100644 --- a/grasp-audit/QUICK_START.md +++ b/grasp-audit/QUICK_START.md | |||
| @@ -108,21 +108,21 @@ use grasp_audit::*; | |||
| 108 | #[tokio::main] | 108 | #[tokio::main] |
| 109 | async fn main() -> Result<()> { | 109 | async fn main() -> Result<()> { |
| 110 | // Create audit client | 110 | // Create audit client |
| 111 | let config = AuditConfig::ci(); | 111 | let config = AuditConfig::isolated(); |
| 112 | let client = AuditClient::new("ws://localhost:7000", config).await?; | 112 | let client = AuditClient::new("ws://localhost:7000", config).await?; |
| 113 | 113 | ||
| 114 | // Run smoke tests | 114 | // Run smoke tests |
| 115 | let results = specs::Nip01SmokeTests::run_all(&client).await; | 115 | let results = specs::Nip01SmokeTests::run_all(&client).await; |
| 116 | 116 | ||
| 117 | // Print results | 117 | // Print results |
| 118 | results.print_report(); | 118 | results.print_report(); |
| 119 | 119 | ||
| 120 | // Check if passed | 120 | // Check if passed |
| 121 | if !results.all_passed() { | 121 | if !results.all_passed() { |
| 122 | eprintln!("Some tests failed!"); | 122 | eprintln!("Some tests failed!"); |
| 123 | std::process::exit(1); | 123 | std::process::exit(1); |
| 124 | } | 124 | } |
| 125 | 125 | ||
| 126 | Ok(()) | 126 | Ok(()) |
| 127 | } | 127 | } |
| 128 | ``` | 128 | ``` |
| @@ -134,17 +134,20 @@ async fn main() -> Result<()> { | |||
| 134 | **Error:** `linker 'cc' not found` | 134 | **Error:** `linker 'cc' not found` |
| 135 | 135 | ||
| 136 | **Solution (NixOS):** | 136 | **Solution (NixOS):** |
| 137 | |||
| 137 | ```bash | 138 | ```bash |
| 138 | nix develop # Use the provided flake.nix | 139 | nix develop # Use the provided flake.nix |
| 139 | ``` | 140 | ``` |
| 140 | 141 | ||
| 141 | **Solution (Other Linux):** | 142 | **Solution (Other Linux):** |
| 143 | |||
| 142 | ```bash | 144 | ```bash |
| 143 | sudo apt-get install build-essential # Debian/Ubuntu | 145 | sudo apt-get install build-essential # Debian/Ubuntu |
| 144 | sudo yum install gcc # RedHat/CentOS | 146 | sudo yum install gcc # RedHat/CentOS |
| 145 | ``` | 147 | ``` |
| 146 | 148 | ||
| 147 | **Solution (macOS):** | 149 | **Solution (macOS):** |
| 150 | |||
| 148 | ```bash | 151 | ```bash |
| 149 | xcode-select --install | 152 | xcode-select --install |
| 150 | ``` | 153 | ``` |
| @@ -154,6 +157,7 @@ xcode-select --install | |||
| 154 | **Error:** `Failed to connect to relay` | 157 | **Error:** `Failed to connect to relay` |
| 155 | 158 | ||
| 156 | **Solutions:** | 159 | **Solutions:** |
| 160 | |||
| 157 | 1. Make sure a relay is running at the specified URL | 161 | 1. Make sure a relay is running at the specified URL |
| 158 | 2. Check firewall settings | 162 | 2. Check firewall settings |
| 159 | 3. Try a different relay URL | 163 | 3. Try a different relay URL |
| @@ -164,6 +168,7 @@ xcode-select --install | |||
| 164 | **Error:** Tests fail with timeout | 168 | **Error:** Tests fail with timeout |
| 165 | 169 | ||
| 166 | **Solutions:** | 170 | **Solutions:** |
| 171 | |||
| 167 | 1. Increase timeout in test code | 172 | 1. Increase timeout in test code |
| 168 | 2. Check relay is responding (try with `websocat`) | 173 | 2. Check relay is responding (try with `websocat`) |
| 169 | 3. Check network connectivity | 174 | 3. Check network connectivity |
| @@ -216,6 +221,7 @@ xcode-select --install | |||
| 216 | ## Support | 221 | ## Support |
| 217 | 222 | ||
| 218 | For issues or questions: | 223 | For issues or questions: |
| 224 | |||
| 219 | 1. Check the documentation in this directory | 225 | 1. Check the documentation in this directory |
| 220 | 2. Review the examples | 226 | 2. Review the examples |
| 221 | 3. Check the test code for usage patterns | 227 | 3. Check the test code for usage patterns |