Skip to content

Commit 7c6d405

Browse files
author
Levent KARAGÖL
committed
Documentation has been updated
1 parent 37a1ebb commit 7c6d405

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Modern, non-blocking and exception free, header-only HTTP Client library for C++
66
[![windows](https://github.com/lk-libs/libcpp-http-client/actions/workflows/windows.yml/badge.svg)](https://github.com/lk-libs/libcpp-http-client/actions/workflows/windows.yml)
77

88

9-
> [!NOTE]
9+
> [!TIP]
1010
> Please read this document before using the library. I know, you don't have time but reading
1111
> this document will save you time. I mean just this file, it's not long at all. Trial and error
1212
> will cost you more time.
@@ -34,8 +34,9 @@ Modern, non-blocking and exception free, header-only HTTP Client library for C++
3434
This is a header only library. So actually, all you need is to add the libcpp-http-client.hpp file
3535
in src folder to your project and start using it with #include.
3636

37-
But this library is a kind of Curl wrapper that uses Curl under the hood. So, you need to add Curl to
38-
your project before to use it.
37+
> [!NOTE]
38+
> This library is a kind of Curl wrapper that uses Curl under the hood. So, you need to add Curl to
39+
> your project before to use it.
3940
4041
You can find usage examples in the examples folder, also find a sample CMakeLists.txt file content below.
4142

@@ -57,9 +58,9 @@ target_link_libraries(myProject PRIVATE libcpp-http-client CURL::libcurl)
5758

5859
Below you can see the simplest use case sending QueryString parameters to an API via HTTP GET.
5960

60-
> [!TIP]
61+
> [!IMPORTANT]
6162
> Please do not use it this way, if more than one call will be made . You do not use the non-blocking
62-
> feature in this way.
63+
> feature in this way. Just keep reading...
6364
6465
```cpp
6566
#include <fstream>

0 commit comments

Comments
 (0)