aboutsummaryrefslogtreecommitdiffstats
path: root/client/README.md
diff options
context:
space:
mode:
authorKristian Aune <kraune@verizonmedia.com>2022-08-11 09:46:07 +0200
committerKristian Aune <kraune@verizonmedia.com>2022-08-11 09:46:07 +0200
commitb746ec29ac4f66fc63bf93b0014d0a6222e06e3b (patch)
tree2c08aa2fc190606cb47daf9748699a61cf863d3e /client/README.md
parentfd1b5165a160af4494da6d1cb3e34f60e6037360 (diff)
Add logo, misc cleanup
Diffstat (limited to 'client/README.md')
-rw-r--r--client/README.md32
1 files changed, 29 insertions, 3 deletions
diff --git a/client/README.md b/client/README.md
index a459ea65b1d..8403e02a485 100644
--- a/client/README.md
+++ b/client/README.md
@@ -1,19 +1,45 @@
<!-- Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. -->
+![Vespa logo](https://vespa.ai/assets/vespa-logo-color.png)
+
# Vespa clients
+This part of the Vespa repository got Vespa client implementations for operations like
+* deploy
+* read/write
+* query
+
+<!-- ToDo: illustration -->
+
+
## Vespa CLI
The Vespa command-line tool, see the [README](go/README.md).
+Use the Vespa CLI to deploy, feed and query a Vespa application,
+for local, self-hosted or [Vespa Cloud](https://cloud.vespa.ai/) instances.
+
+
+
+## pyvespa
+[pyvespa](https://pyvespa.readthedocs.io/) provides a python API to Vespa -
+use it to create, modify, deploy and interact with running Vespa instances.
+The main pyvespa goal is to allow for faster prototyping
+and to facilitate Machine Learning experiments for Vespa applications.
+
## Vespa FE (fixme: better name and description here)
-This is a work-in-progress javascript app for various use cases.
+This is a [work-in-progress javascript app](js/app) for querying a Vespa application.
+
-## vespa_query_dsl
+----
+
+## Misc
+
+<!-- ToDo: move this / demote this somehow -->
+### 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: