Skip to content
Snippets Groups Projects
Commit fbb232a9 authored by florian's avatar florian
Browse files

DOC: Add placeholder for examples

parent 168e4c26
No related branches found
No related tags found
1 merge request!6DOC: Add sections to documentation
......@@ -7,6 +7,7 @@ makedocs(
pages = [
"Home" => "index.md",
"Getting started" => "README_SETUP.md",
"examples.md",
"Library" => "api.md",
],
)
# Examples
**TODO** Fill the sections below once the parts have been implemented.
## Connect to a CaosDB server
See also the hints on the [Installation](@ref) and set-up of
CaosDB.jl. CaosDB.jl makes use of the C++ client of CaosDB, so in
order to connect to a CaosDB server you first have to configure the
connection via a configuration file as explained in the [documentation
of CaosDB's C++
client](https://docs.indiscale.com/caosdb-cpplib). Once the
configuration is set up, connecting to the server is as easy as
```julia
using CaosDB
connection = CaosDB.Connection.connect()
```
which will establish a connection and print the version of the server
you are connected to.
## Retrieve a Record
## Execute queries
## Insert, update, and delete entities
## Download a file
......@@ -3,10 +3,11 @@
Welcome to CaosDB.jl, the Julia Client for
[CaosDB](https://caosdb.org), the opensource research data management
system. In here you find instruction on how to [Set-up
CaosDB.jl](@ref) and an overview of [CaosDB.jl's API](@ref).
CaosDB.jl](@ref), some introductory [Examples](@ref), and an overview
of [CaosDB.jl's API](@ref).
## Contents
```@contents
Pages = ["README_SETUP.md", "api.md"]
Pages = ["README_SETUP.md", "examples.md", "api.md"]
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment