Skip to content

Commit ae50992

Browse files
authored
cleaned readme (#128)
1 parent 03c127d commit ae50992

File tree

1 file changed

+2
-48
lines changed

1 file changed

+2
-48
lines changed

README.md

Lines changed: 2 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Countly C++ SDK
44

5-
This repository contains the Countly C++ SDK, which can be integrated into C++ applications. The Countly C++ SDK is intended to be used with [Countly Community Edition](https://github.com/Countly/countly-server) or [Countly Enterprise Edition](https://count.ly/product).
5+
This repository contains the Countly C++ SDK, which can be integrated into C++ applications. The Countly C++ SDK is intended to be used with [Countly Lite](https://countly.com/lite), [Countly Flex](https://countly.com/flex) or [Countly Enterprise](https://countly.com/enterprise).
66

77
## What is Countly?
88
[Countly](https://count.ly) is a product analytics solution and innovation enabler that helps teams track product performance and customer journey and behavior across [mobile](https://count.ly/mobile-analytics), [web](http://count.ly/web-analytics),
@@ -11,7 +11,7 @@ and [desktop](https://count.ly/desktop-analytics) applications. [Ensuring privac
1111
Track, measure, and take action - all without leaving Countly.
1212

1313
* **Questions or feature requests?** [Join the Countly Community on Discord](https://discord.gg/countly)
14-
* **Looking for the Countly Server?** [Countly Community Edition repository](https://github.com/Countly/countly-server)
14+
* **Looking for the Countly Server?** [Countly Server repository](https://github.com/Countly/countly-server)
1515
* **Looking for other Countly SDKs?** [An overview of all Countly SDKs for mobile, web and desktop](https://support.count.ly/hc/en-us/articles/360037236571-Downloading-and-Installing-SDKs#officially-supported-sdks)
1616

1717
## Integrating Countly SDK in your projects
@@ -29,52 +29,6 @@ This SDK supports the following features:
2929
* [User Profiles](https://support.count.ly/hc/en-us/articles/4403281285913-User-Profiles)
3030
* [A/B Testing](https://support.count.ly/hc/en-us/articles/4416496362393-A-B-Testing-)
3131

32-
## Usage
33-
34-
Typical use is:
35-
36-
```C++
37-
#include "countly.hpp"
38-
using namespace cly;
39-
40-
int main(int argc, char *argv[]) {
41-
Countly& ct = Countly::getInstance();
42-
// OS, OS_version, device, resolution, carrier, app_version);
43-
ct.SetMetrics("Windows 10", "10.22", "Mac", "800x600", "Carrier", "1.0");
44-
ct.setCustomUserDetails({{"Account Type", "Basic"}, {"Employer", "Company4"}});
45-
// Server and port
46-
ct.Start("abf2034f975393fa994d1cf8adf9a93e4a29ac29", "https://myserver.com", 403);
47-
ct.SetMinUpdatePeriod(2000);
48-
49-
ct.RecordEvent("MyCustomEvent", 123);
50-
ct.RecordEvent("MyCustomEvent", 17);
51-
ct.RecordEvent("MyCustomEvent", 34);
52-
ct.RecordEvent("AnotherCustomEvent", 644, 13.3);
53-
54-
// Your program is supposed to do something..
55-
56-
return 0;
57-
}
58-
```
59-
60-
## Testing
61-
62-
Build with the option `COUNTLY_BUILD_TESTS` on to build an executable that will run the tests:
63-
64-
``` shell
65-
cmake -D COUNTLY_BUILD_TESTS=1 -B build . # or do it interactively with ccmake
66-
cd build
67-
make
68-
./countly-tests
69-
```
70-
71-
To run unit tests associated with 'SQLITE' and 'Custom SHA-256' build executable with the options
72-
`COUNTLY_USE_SQLITE` and `COUNTLY_BUILD_TESTS`:
73-
74-
``` shell
75-
cmake -DCOUNTLY_BUILD_TESTS=1 -DCOUNTLY_USE_SQLITE=1 -DCOUNTLY_USE_CUSTOM_SHA256=1 -B build
76-
```
77-
7832
## Security
7933
Security is very important to us. If you discover any issue regarding security, please disclose the information responsibly by sending an email to [email protected] and **not by creating a GitHub issue**.
8034

0 commit comments

Comments
 (0)