From 0bddce4254666e2c1ee4f17ae60ef6760481bc35 Mon Sep 17 00:00:00 2001 From: Nicola Coretti Date: Fri, 3 Jan 2025 08:34:51 +0100 Subject: [PATCH] Update README.md * Remove outdated links * Add a link to the documentation * Add a link to the source code --- README.md | 26 +++++--------------------- 1 file changed, 5 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 932fcea..b107cca 100644 --- a/README.md +++ b/README.md @@ -23,26 +23,10 @@ You may expect significant performance improvement over ODBC in a single process PyEXASOL provides API to read & write multiple data streams in parallel using separate processes, which is necessary to fully utilize hardware and achieve linear scalability. With PyEXASOL you are no longer limited to a single CPU core. - -## Quick links -- [Getting started](#getting-started) -- [Reference](/docs/REFERENCE.md) -- [Examples](/docs/EXAMPLES.md) -- [Best practices](/docs/BEST_PRACTICES.md) -- [Local config (.ini file)](/docs/LOCAL_CONFIG.md) -- [SQL formatting](/docs/SQL_FORMATTING.md) -- [HTTP Transport](/docs/HTTP_TRANSPORT.md) -- [HTTP Transport (multiprocessing)](/docs/HTTP_TRANSPORT_PARALLEL.md) -- [Parallelism](/docs/PARALLELISM.md) -- [SSL encryption](/docs/ENCRYPTION.md) -- [WebSocket protocol versions](/docs/PROTOCOL_VERSION.md) -- [Performance tests](/docs/PERFORMANCE.md) -- [UDF scripts output](/docs/SCRIPT_OUTPUT.md) -- [DB-API 2.0 compatibility](/docs/DBAPI_COMPAT.md) -- [Optional dependencies](/docs/DEPENDENCIES.md) -- [Changelog](/CHANGELOG.md) -- [Developer Guide](/docs/DEVELOPER_GUIDE.md) - +--- +* Documentation: [https://exasol.github.io/pyexasol/](https://exasol.github.io/pyexasol/index.html) +* Source Code: [https://github.com/exasol/pyexasol](https://github.com/exasol/pyexasol) +--- ## PyEXASOL main concepts @@ -87,7 +71,7 @@ df = C.export_to_pandas("SELECT * FROM EXA_ALL_USERS") print(df.head()) ``` -You may set up [local config](/docs/LOCAL_CONFIG.md) to store your personal Exasol credentials and connection options: +You may set up `local config` to store your personal Exasol credentials and connection options: ```python import pyexasol