Skip to content

Commit cd15e5a

Browse files
authored
Update README.md
1 parent e973dd1 commit cd15e5a

File tree

1 file changed

+4
-13
lines changed

1 file changed

+4
-13
lines changed

README.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,14 @@
1010

1111
</div>
1212

13-
Search-query is a Python package for parsing, validating, simplifying, and serializing literature search queries.
14-
It currently supports PubMed and Web of Science, and can be extended to support other databases.
15-
As a default it relies on the JSON schema proposed by an expert panel (Haddaway et al., 2022).
16-
The package can be used programmatically or through the command line, has zero dependencies, and can therefore be integrated in a variety of environments.
17-
The heuristics, parsers, and linters are battle-tested on over 500 peer-reviewed queries registered at [searchRxiv](https://www.cabidigitallibrary.org/journal/searchrxiv).
13+
Search-query is a Python package for **translating academic literature search queries (i.e., parsing and serializing)**, but also for **validating, simplifying, and improving** them.
14+
It implements various syntax validation checks ("linters" for search queries) and prints instructive messages to inform users about potential issues.
1815

19-
## Documentation
20-
21-
[docs](docs/readme.md)
22-
23-
## Demo
24-
25-
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/CoLRev-Environment/search-query/HEAD?labpath=docs%2Fsource%2Fdemo.ipynb)
16+
For more, see the [documentation](docs/readme.md).
2617

2718
## How to cite
2819

29-
TODO: main citation
20+
Eckhardt, P., Ernst, K., Fleischmann, T., Geßler, A., Schnickmann, K., Thurner, L., and Wagner, G. "search-query: An Open-Source Python Library for Academic Search Queries".
3021

3122
The package was developed as part of Bachelor's theses:
3223

0 commit comments

Comments
 (0)