You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-10Lines changed: 9 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Marsy is a library that allow you to deserialize and manage data returned by [Sp
10
10
-[Start](#start)
11
11
-[Queries](#queries)
12
12
-[Size of binary in debug mode](#size-of-binary-in-debug-mode)
13
-
-[There's few things that Marsy doesn't provide](#theres-few-things-that-marsy-doesnt-provide)
13
+
-[Things you should be aware of](#things-you-should-be-aware-of)
14
14
-[Internet connection](#internet-connection)
15
15
-[Dates parsing](#dates-parsing)
16
16
-[Sample code](#sample-code)
@@ -21,7 +21,7 @@ Marsy is a library that allow you to deserialize and manage data returned by [Sp
21
21
## Start
22
22
To use it just add source files to your project.
23
23
24
-
You can use functions provided by services or write your own services on top of provided parsers. Remember to look [here](#theres-few-things-that-marsy-doesnt-provide) before start.
24
+
You can use functions provided by services or write your own services on top of provided parsers. Remember to look [here](#things-you-should-be-aware-of) before start.
25
25
26
26
Library uses C++17 features. You need to remember it, when you compile your program.
27
27
@@ -44,14 +44,17 @@ Currently Marsy doesn't provide query builder for these: `options -> select`, `o
44
44
## Size of binary in debug mode
45
45
Since Marsy includes [JSON](https://github.com/nlohmann/json) in several classes, output program can be huge when compiled in debug mode (I achieved 60MB binaries). Remember to roll it out as release, when you done with testing.
46
46
47
-
# There's few things that Marsy doesn't provide
47
+
# Things you should be aware of
48
48
## Internet connection
49
49
Marsy doesn't handle internet connection, so you need to provide implementation of `IConnection` interface. Enum `ResponseStatus` is to help you handle different statuses returned by API. Service will parse returned JSON only when status is `ResponseStatus::ok`.
50
50
51
51
There are 2 reasons why I made is as it is:
52
52
* C++ doesn't have internet connection in STL yet. I did not want to include big library or use different system APIs to provide support for more than one platform e.g. (WinAPI, POSIX etc.),
53
53
* maybe you already have library with internet connection in your project or you want to use one that you like the most.
54
54
55
+
**However**
56
+
I made `IConnector` implementation based on curl and curlcpp. You can find it [here](https://github.com/AzuxDario/Marsy-CurlConnector).
57
+
55
58
## Dates parsing
56
59
Marsy doesn't parse dates returned by API. They're stored as strings.
57
60
@@ -60,18 +63,14 @@ Marsy doesn't parse dates returned by API. They're stored as strings.
0 commit comments