restore readme

README.md

@@ -0,0 +1,69 @@
+# Reduct Storage Client SDK for C++
+
+Open source client for [Reduct Storage](https://reduct-storage.dev) written in C++20.
+
+## Features
+
+* Implement Reduct Storage HTTP API v0.1.0
+* Exception free
+* Tested on Linux AMD64
+
+## Example
+
+```cpp
+
+#include <reduct/client.h>
+#include <fmt/core.h>
+
+using reduct::IClient;
+
+int main() {
+ auto client = IClient::Build("http://127.0.0.1:8383");
+
+ auto [result, err] = client->GetInfo();
+ if (err) {
+ fmt::print("Error: {}", err.ToString());
+ return -1;
+ }
+
+ fmt::print("Server version: {}\n", result.version);
+ // Create a bucket
+ auto [bucket, create_err] =
+ client->CreateBucket("bucket", IBucket::Settings{.quota_type = IBucket::QuotaType::kFifo, 
+ .quota_size = 1000000});
+ if (create_err) {
+ fmt::print("Error: {}\n", create_err.ToString());
+ return -1;
+ }
+
+ // Write some data to the storage
+ IBucket::Time ts = IBucket::Time::clock::now();
+ [[maybe_unused]] auto write_err = bucket->Write("entry-1", "some_data1", ts);
+
+ auto [data, read_err] = bucket->Read("entry-1", ts);
+ fmt::print("Read data: {}\n", data);
+ return 0;
+}
+```
+
+## Build
+
+* GCC 11.2 or higher (support C++20)
+* CMake 3.18 or higher
+* Conan 1.40 (optional)
+
+```shell
+git clone https://github.com/reduct-storage/reduct-cpp.git
+cd reduct-cpp
+mkdir build && cd build
+cmake -DCMAKE_BUILD_TYPE=Release ..
+cmake --build .
+sudo cmake --build . --target install
+```
+
+cmake tries to use package manager `conan` if it is installed. If it isn't, it downloads all the dependencies by using
+FetchContent. To use Reduct Storage SDK you need only to use `find_pacakge` in your cmake lists:
+
+```cmake
+find_package(ReductCpp)
+```