Commit fee7a022 authored by pfandzelter's avatar pfandzelter
Browse files

Update README.md

parent aa52e1e8
Pipeline #162806 passed with stages
in 16 minutes and 3 seconds
......@@ -266,13 +266,13 @@ If you want to use this backend, you will need to generate certificates for the
### API
**The ALExANDRA middleware for client access is actively being worked on. For now, access to FReD is only possible directly via the gRPC API.**
**Clients should preferably use the ALExANDRA middleware! All API methods are available here, plus some nice-to-haves such as client-centric consistency when using version vectors!**
FReD uses a gRPC API.
The main benefit is that language libraries can easily be generated by using the `protoc` compiler.
Compare that to JSON + HTTP + REST, where you need to roll your language-specific code or we would need to provide different libraries.
For test purposes, the compiled Go language files are already available in `./proto/client`.
For test purposes, the compiled Go and Python language files are already available in `./proto/middleware`.
To compile your own language bindings, read more about protobuf [here](https://developers.google.com/protocol-buffers).
The API provides endpoints to interact with FReD on five different aspects:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment