diff --git a/docs/make.jl b/docs/make.jl index 439db09f44e528de9ed8746ca901d40e9e02da56..682ad3ca695f69705e550d9234e25b75a530c44c 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -7,6 +7,7 @@ makedocs( pages = [ "Home" => "index.md", "Getting started" => "README_SETUP.md", + "examples.md", "Library" => "api.md", ], ) diff --git a/docs/src/examples.md b/docs/src/examples.md new file mode 100644 index 0000000000000000000000000000000000000000..248fb1ac5fce9af3ec103fd7eed508ecfd5afcc4 --- /dev/null +++ b/docs/src/examples.md @@ -0,0 +1,29 @@ +# 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 diff --git a/docs/src/index.md b/docs/src/index.md index dd08abc213aac1d07213b173f28dc979ed71ef1f..86894e45d5367de225b2ae4bb959e9a5214fa89b 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -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"] ```