Skip to content

Commit 3e49fe5

Browse files
authored
[Doc] Add links to client docs and feature matrix in README.md (#264)
* Update README.md * Update README.md
1 parent 4338d45 commit 3e49fe5

File tree

1 file changed

+26
-18
lines changed

1 file changed

+26
-18
lines changed

README.md

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -21,31 +21,35 @@
2121

2222
# Pulsar C++ client library
2323

24-
Examples for using the API to publish and consume messages can be found under the [examples](https://github.com/apache/pulsar-client-cpp/tree/main/examples) folder.
24+
Pulsar C++ clients support a variety of Pulsar features to enable building applications connecting to your Pulsar cluster.
25+
26+
For the supported Pulsar features, see [Client Feature Matrix](https://pulsar.apache.org/client-feature-matrix/).
27+
28+
For how to use APIs to publish and consume messages, see [examples](https://github.com/apache/pulsar-client-cpp/tree/main/examples).
2529

2630
## Generate the API documents
2731

2832
Pulsar C++ client uses [doxygen](https://www.doxygen.nl) to build API documents. After installing `doxygen`, you only need to run `doxygen` to generate the API documents whose main page is under the `doxygen/html/index.html` path.
2933

3034
## Requirements
3135

32-
* A C++ compiler that supports C++11, like GCC >= 4.8
33-
* CMake >= 3.13
34-
* [Boost](http://www.boost.org/)
35-
* [Protocol Buffer](https://developers.google.com/protocol-buffers/) >= 3
36-
* [libcurl](https://curl.se/libcurl/)
37-
* [openssl](https://github.com/openssl/openssl)
36+
- A C++ compiler that supports C++11, like GCC >= 4.8
37+
- CMake >= 3.13
38+
- [Boost](http://www.boost.org/)
39+
- [Protocol Buffer](https://developers.google.com/protocol-buffers/) >= 3
40+
- [libcurl](https://curl.se/libcurl/)
41+
- [openssl](https://github.com/openssl/openssl)
3842

3943
The default supported [compression types](include/pulsar/CompressionType.h) are:
4044

41-
* `CompressionNone`
42-
* `CompressionLZ4`
45+
- `CompressionNone`
46+
- `CompressionLZ4`
4347

4448
If you want to enable other compression types, you need to install:
4549

46-
* `CompressionZLib`: [zlib](https://zlib.net/)
47-
* `CompressionZSTD`: [zstd](https://github.com/facebook/zstd)
48-
* `CompressionSNAPPY`: [snappy](https://github.com/google/snappy)
50+
- `CompressionZLib`: [zlib](https://zlib.net/)
51+
- `CompressionZSTD`: [zstd](https://github.com/facebook/zstd)
52+
- `CompressionSNAPPY`: [snappy](https://github.com/google/snappy)
4953

5054
If you want to build and run the tests, you need to install [GTest](https://github.com/google/googletest). Otherwise, you need to add CMake option `-DBUILD_TESTS=OFF`.
5155

@@ -55,9 +59,9 @@ If you want to use `ClientConfiguration::setLogConfFilePath`, you need to instal
5559

5660
Pulsar C++ Client Library has been tested on:
5761

58-
* Linux
59-
* Mac OS X
60-
* Windows x64
62+
- Linux
63+
- Mac OS X
64+
- Windows x64
6165

6266
## Compilation
6367

@@ -172,7 +176,9 @@ Take Windows 64-bit library as an example, you only need to run
172176
vcpkg install --feature-flags=manifests --triplet x64-windows
173177
```
174178

175-
> NOTE: For Windows 32-bit library, change `x64-windows` to `x86-windows`, see [here](https://github.com/microsoft/vcpkg/blob/master/docs/users/triplets.md) for more details about the triplet concept in Vcpkg.
179+
> **NOTE**:
180+
>
181+
> For Windows 32-bit library, change `x64-windows` to `x86-windows`, see [here](https://github.com/microsoft/vcpkg/blob/master/docs/users/triplets.md) for more details about the triplet concept in Vcpkg.
176182
177183
The all dependencies, which are specified by [vcpkg.json](vcpkg.json), will be installed in `vcpkg_installed/` subdirectory,
178184

@@ -223,7 +229,7 @@ build/lib/Release/pulsar.dll
223229

224230
#### Examples
225231

226-
Add windows environment paths:
232+
Add Windows environment paths:
227233

228234
```
229235
build/lib/Release
@@ -257,8 +263,10 @@ See the [wireshark](wireshark/) directory for details.
257263

258264
## Requirements for Contributors
259265

260-
It's required to install [LLVM](https://llvm.org/builds/) for `clang-tidy` and `clang-format`. Pulsar C++ client use `clang-format` **11** to format files. `make format` automatically formats the files.
266+
It's required to install [LLVM](https://llvm.org/builds/) for `clang-tidy` and `clang-format`. Pulsar C++ client use `clang-format` **11** to format files. `make format` automatically formats the files.
261267

262268
For Ubuntu users, you can install `clang-format-11` via `apt install clang-format-11`. For other users, run `./build-support/docker-format.sh` if you have Docker installed.
263269

264270
We welcome contributions from the open source community, kindly make sure your changes are backward compatible with GCC 4.8 and Boost 1.53.
271+
272+
If your contribution adds Pulsar features for C++ clients, you need to update both the [Pulsar docs](https://pulsar.apache.org/docs/client-libraries/) and the [Client Feature Matrix](https://pulsar.apache.org/client-feature-matrix/). See [Contribution Guide](https://pulsar.apache.org/contribute/site-intro/#pages) for more details.

0 commit comments

Comments
 (0)