Skip to content

Commit 5c62245

Browse files
Polish README to be more like Django
Updated examples section and improved support information in README. Signed-off-by: Philippe Noël <21990816+philippemnoel@users.noreply.github.com>
1 parent 03be80b commit 5c62245

1 file changed

Lines changed: 17 additions & 25 deletions

File tree

README.md

Lines changed: 17 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -279,42 +279,34 @@ indexing.tokenize.from_config({"filters": ["lowercase"]})
279279

280280
## Examples
281281

282-
- Quick Start: [setup](examples/quickstart/setup.py), [run](examples/quickstart/quickstart.py)
283-
- Faceted Search: [setup](examples/faceted_search/setup.py), [run](examples/faceted_search/faceted_search.py)
284-
- Autocomplete: [setup](examples/autocomplete/setup.py), [run](examples/autocomplete/autocomplete.py)
285-
- More Like This: [setup](examples/more_like_this/setup.py), [run](examples/more_like_this/more_like_this.py)
286-
- Hybrid Search (RRF): [setup](examples/hybrid_rrf/setup.py), [run](examples/hybrid_rrf/hybrid_rrf.py)
287-
- RAG: [setup](examples/rag/setup.py), [run](examples/rag/rag.py)
288-
289-
## Testing
290-
291-
Use repository script helpers:
292-
293-
```bash
294-
./scripts/run_unit_tests.sh
295-
./scripts/run_integration_tests.sh
296-
./scripts/run_examples.sh
297-
```
282+
- [Quick Start](examples/quickstart/quickstart.py)
283+
- [Faceted Search](examples/faceted_search/faceted_search.py)
284+
- [Autocomplete](examples/autocomplete/autocomplete.py)
285+
- [More Like This](examples/more_like_this/more_like_this.py)
286+
- [Hybrid Search (RRF)](examples/hybrid_rrf/hybrid_rrf.py)
287+
- [RAG](examples/rag/rag.py)
298288

299289
## Documentation
300290

301-
- [ParadeDB Docs](https://docs.paradedb.com)
302-
- [ParadeDB Website](https://paradedb.com)
303-
- [Changelog](CHANGELOG.md)
291+
- **Package Documentation**: <https://paradedb.github.io/django-paradedb>
292+
- **ParadeDB Official Docs**: <https://docs.paradedb.com>
293+
- **ParadeDB Website**: <https://paradedb.com>
304294

305295
## Contributing
306296

307-
See [CONTRIBUTING.md](CONTRIBUTING.md) for setup, linting, tests, and PR workflow.
297+
See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, running tests, linting, and the PR workflow.
308298

309299
## Support
310300

311-
If you found a bug or need a feature, open a [GitHub Issue](https://github.com/paradedb/sqlalchemy-paradedb/issues/new/choose).
301+
If you're missing a feature or have found a bug, please open a
302+
[GitHub Issue](https://github.com/paradedb/django-paradedb/issues/new/choose).
303+
304+
To get community support, you can:
312305

313-
Community and team support:
306+
- Post a question in the [ParadeDB Slack Community](https://paradedb.com/slack)
307+
- Ask for help on our [GitHub Discussions](https://github.com/paradedb/paradedb/discussions)
314308

315-
- [ParadeDB Slack Community](https://paradedb.com/slack)
316-
- [ParadeDB GitHub Discussions](https://github.com/paradedb/paradedb/discussions)
317-
- [Commercial support](mailto:sales@paradedb.com)
309+
If you need commercial support, please [contact the ParadeDB team](mailto:sales@paradedb.com).
318310

319311
## License
320312

0 commit comments

Comments
 (0)