Skip to content

Commit a2302df

Browse files
mldangelorenovate[bot]claude
authored
docs: overhaul README to clarify wrapper nature and add telemetry disclosure (#28)
* chore(deps): lock file maintenance (#16) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore(deps): lock file maintenance (#17) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore(deps): lock file maintenance (#21) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Michael <michael.l.dangelo@gmail.com> * chore(deps): lock file maintenance (#23) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Michael <michael.l.dangelo@gmail.com> * chore(deps): lock file maintenance (#24) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Michael <michael.l.dangelo@gmail.com> * docs: overhaul README to clarify wrapper nature and add telemetry disclosure - Reframe repo as a thin pip wrapper pointing to promptfoo/promptfoo as the source of truth for all features and documentation - Add telemetry disclosure section documenting what is collected, where it goes, and how to disable it (PROMPTFOO_DISABLE_TELEMETRY=1) - Update version pinning docs now that PROMPTFOO_VERSION is implemented - Simplify structure: less marketing copy, more actionable guidance - Direct users to the main project for features/bugs Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs: add telemetry disclosure, fix contributing links, minor cleanup - Add telemetry section documenting what is collected and how to opt out (PROMPTFOO_DISABLE_TELEMETRY=1) - Update contributing section to split wrapper issues (here) vs. promptfoo features/bugs (promptfoo/promptfoo) and link to CONTRIBUTING.md - Remove unnecessary version pin from requirements.txt example - Fix bare nodejs.org URL to markdown link Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 0d7d8f0 commit a2302df

1 file changed

Lines changed: 17 additions & 6 deletions

File tree

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ poetry run promptfoo eval
142142
### With requirements.txt
143143

144144
```bash
145-
echo "promptfoo>=0.2.0" >> requirements.txt
145+
echo "promptfoo" >> requirements.txt
146146
pip install -r requirements.txt
147147
promptfoo eval
148148
```
@@ -180,7 +180,7 @@ The wrapper needs Node.js to run. Install it:
180180
181181
- **macOS**: `brew install node`
182182
- **Ubuntu/Debian**: `sudo apt install nodejs npm`
183-
- **Windows**: Download from https://nodejs.org/
183+
- **Windows**: Download from [nodejs.org](https://nodejs.org/)
184184
- **Any OS**: Use [nvm](https://github.com/nvm-sh/nvm)
185185

186186
### Slow First Run
@@ -210,14 +210,25 @@ Or install a specific version globally:
210210
npm install -g promptfoo@0.95.0
211211
```
212212

213+
### Telemetry
214+
215+
This wrapper collects anonymous usage telemetry to help improve the package, mirroring the telemetry in the main promptfoo project.
216+
217+
**What is collected:** A random anonymous user ID, wrapper version, Python version, and whether you're running in CI. If you've previously logged into promptfoo and your email is stored in `~/.promptfoo/promptfoo.yaml`, that is also sent.
218+
219+
**To opt out:**
220+
221+
```bash
222+
export PROMPTFOO_DISABLE_TELEMETRY=1
223+
```
224+
213225
## Contributing
214226

215-
We welcome contributions! Check out our [contributing guide](https://www.promptfoo.dev/docs/contributing/) to get started.
227+
**For promptfoo features, docs, and bugs:** contribute to [promptfoo/promptfoo](https://github.com/promptfoo/promptfoo).
216228

217-
Join our [Discord community](https://discord.gg/promptfoo) for help and discussion.
229+
**For pip wrapper issues** (installation, Python shim, CI integration): open issues here. See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup.
218230

219-
**For wrapper-specific issues**: Report them in this repository
220-
**For promptfoo features/bugs**: Report in the [main project](https://github.com/promptfoo/promptfoo)
231+
Join our [Discord community](https://discord.gg/promptfoo) for help and discussion.
221232

222233
<a href="https://github.com/promptfoo/promptfoo/graphs/contributors">
223234
<img src="https://contrib.rocks/image?repo=promptfoo/promptfoo" />

0 commit comments

Comments
 (0)