diff options
| author | Kristian Aune <kraune@verizonmedia.com> | 2022-06-16 14:24:49 +0200 |
|---|---|---|
| committer | Kristian Aune <kraune@verizonmedia.com> | 2022-06-16 14:24:49 +0200 |
| commit | 478462deb990e75f3745d8208e55a48909db020a (patch) | |
| tree | e772e0689ac2d3f5a5b3e87c7136a617f561f23a /client | |
| parent | 06349e640417bfe665abf99d8e16a4517f5a7cf5 (diff) | |
Improve Vespa clients readme
Diffstat (limited to 'client')
| -rw-r--r-- | client/README.md | 21 |
1 files changed, 14 insertions, 7 deletions
diff --git a/client/README.md b/client/README.md index a90efb7c8fb..a459ea65b1d 100644 --- a/client/README.md +++ b/client/README.md @@ -1,15 +1,22 @@ <!-- Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. --> -# vespa_query_dsl -This lib is used for composing vespa YQL queries -Reference: https://docs.vespa.ai/en/reference/query-language-reference.html +# Vespa clients -# usage -Please refer to the unit test: +## Vespa CLI +The Vespa command-line tool, see the [README](go/README.md). -https://github.com/vespa-engine/vespa/blob/master/client/src/test/java/ai/vespa/client/dsl/QTest.java -# todos +## Vespa FE (fixme: better name and description here) +This is a work-in-progress javascript app for various use cases. + + +## vespa_query_dsl +This lib is used for composing Vespa +[YQL queries](https://docs.vespa.ai/en/reference/query-language-reference.html). + +For usage, refer to the [QTest.java](src/test/java/ai/vespa/client/dsl/QTest.java) unit test. + +ToDos: - [ ] support `predicate` (https://docs.vespa.ai/en/predicate-fields.html) - [ ] support methods for checking positive/negative conditions for specific field - [X] support order by annotation |