Skip to content

Commit e2c3710

Browse files
committed
Applying readme template
1 parent 75dfb71 commit e2c3710

File tree

1 file changed

+26
-64
lines changed

1 file changed

+26
-64
lines changed

README.md

Lines changed: 26 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,34 @@
1-
# Countly C++ SDK
2-
3-
![travis build status](https://img.shields.io/travis/Countly/countly-sdk-cpp?style=flat-square)
4-
5-
This repository contains the portable Countly C++ SDK.
6-
7-
## What's Countly?
8-
9-
[Countly](http://count.ly) is an innovative, real-time, open source mobile analytics and push notifications platform. It collects data from mobile devices, and visualizes this information to analyze mobile application usage and end-user behavior.
10-
There are two parts of Countly: [the server that collects and analyzes data](http://github.com/countly/countly-server), and mobile SDK that sends this data. Both parts are open source with different licensing terms.
11-
12-
* **Slack user?** [Join our Slack community](http://slack.count.ly:3000/)
13-
* **Questions?** [Ask in our Community forum](http://community.count.ly)
14-
15-
## About
16-
17-
This repository includes the Countly C++ SDK.
1+
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/f3268a85b0034b68aa4fc47c9dce596c)](https://www.codacy.com/gh/Countly/countly-sdk-cpp/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Countly/countly-sdk-cpp&utm_campaign=Badge_Grade)
182

19-
Need help? See [Countly SDK for C++](https://support.count.ly/hc/en-us/articles/4416163384857-C-) documentation at [Countly Resources](http://resources.count.ly), or ask us on our [Countly Analytics Community Slack channel](http://slack.count.ly).
3+
# Countly C++ SDK
204

21-
## Security
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).
226

23-
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**.
7+
## What is Countly?
8+
[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),
9+
and [desktop](https://count.ly/desktop-analytics) applications. [Ensuring privacy by design](https://count.ly/privacy-by-design), Countly allows you to innovate and enhance your products to provide personalized and customized customer experiences, and meet key business and revenue goals.
2410

25-
## Dependencies and building
11+
Track, measure, and take action - all without leaving Countly.
2612

27-
Countly C++ SDK has been designed to work with very few dependencies in order to be available on most platforms.
28-
In order to build this SDK, you need:
13+
* **Slack user?** [Join our Slack Community](https://slack.count.ly)
14+
* **Questions or feature requests?** [Post in our Community Forum](https://support.count.ly/hc/en-us/community/topics)
15+
* **Looking for the Countly Server?** [Countly Community Edition repository](https://github.com/Countly/countly-server)
16+
* **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)
2917

30-
* a C++ compiler with C++14 support
31-
* libcurl (with openssl) and its headers if you are on *nix
32-
* cmake >= 3.13
18+
## Integrating Countly SDK in your projects
3319

34-
First, clone the repository with its submodules:
20+
Link to the script and call helper methods based on what you want to track: sessions, views, clicks, custom events, user data, etc. and for much more [check out our documentation](https://support.count.ly/hc/en-us/articles/4416163384857-C-).
3521

36-
``` shell
37-
git clone --recursive https://github.com/Countly/countly-sdk-cpp
38-
```
22+
For information about how to add the SDK to your project, please check [this section of the documentation](https://support.count.ly/hc/en-us/articles/4416163384857-C-#adding-the-sdk-to-the-project).
3923

40-
If you want to use SQLite to store session data persistently, build sqlite:
24+
You can find minimal SDK integration information for your project in [this section of the documentation](https://support.count.ly/hc/en-us/articles/4416163384857-C-#minimal-setup).
4125

42-
``` shell
43-
# assuming we are on project root
44-
cd vendor/sqlite
45-
cmake -D BUILD_SHARED_LIBS=1 -B build . # out of source build, we don't like clutter :)
46-
# we define `BUILD_SHARED_LIBS` because sqlite's cmake file compiles statically by default for some reason
47-
cd build
48-
make # you might want to add something like -j8 to parallelize the build process
49-
```
26+
For an example integration of this SDK, you can have a look [here](https://github.com/Countly/countly-sdk-cpp/tree/master/examples).
5027

51-
The cmake build flow is pretty straightforward:
52-
53-
``` shell
54-
# assuming we are on project root again
55-
ccmake -B build . # this will launch a TUI, configure the build as you see fit
56-
cd build
57-
make
58-
```
28+
This SDK supports the following features:
29+
* [Analytics](https://support.count.ly/hc/en-us/articles/4431589003545-Analytics)
30+
* [User Profiles](https://support.count.ly/hc/en-us/articles/4403281285913-User-Profiles)
31+
* [A/B Testing](https://support.count.ly/hc/en-us/articles/4416496362393-A-B-Testing-)
5932

6033
## Usage
6134

@@ -104,23 +77,11 @@ To run unit tests associated with 'SQLITE' and 'Custom SHA-256' build executable
10477
cmake -DCOUNTLY_BUILD_TESTS=1 -DCOUNTLY_USE_SQLITE=1 -DCOUNTLY_USE_CUSTOM_SHA256=1 -B build
10578
```
10679

107-
## Other Github resources
108-
109-
This SDK needs one of the following Countly Editions to work:
110-
111-
* Countly Community Edition, [downloadable from Github](https://github.com/Countly/countly-server)
112-
* [Countly Enterprise Edition](http://count.ly/product)
113-
114-
For more information about Countly Enterprise Edition, see [comparison of different Countly editions](https://count.ly/compare/)
115-
116-
There are also other Countly SDK repositories (both official and community supported) on [Countly resources](http://resources.count.ly/v1.0/docs/downloading-sdks).
117-
118-
## How can I help you with your efforts?
119-
Glad you asked. We need ideas, feedback and constructive comments. All your suggestions will be taken care with utmost importance. We are on [Twitter](http://twitter.com/gocountly) and [Facebook](http://www.facebook.com/Countly) if you would like to keep up with our fast progress!
80+
## Security
81+
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**.
12082

12183
## Badges
122-
123-
If you like Countly, [why not use one of our badges](https://count.ly/brand-assets) and give a link back to us, so others know about this wonderful platform?
84+
If you like Countly, [why not use one of our badges](https://count.ly/brand-assets) and give a link back to us so others know about this wonderful platform?
12485

12586
<a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/dark.svg?v2" alt="Countly - Product Analytics" /></a>
12687

@@ -134,6 +95,7 @@ If you like Countly, [why not use one of our badges](https://count.ly/brand-asse
13495
<a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/light.svg" alt="Countly - Product Analytics" /></a>
13596
```
13697

137-
### Support
98+
## How can I help you with your efforts?
99+
Glad you asked! We need ideas, feedback and constructive comments. All your suggestions will be taken care of with utmost importance. For feature requests and engaging with the community, join [our Slack Community](https://slack.count.ly) or [Community Forum](https://support.count.ly/hc/en-us/community/topics).
138100

139-
For Community support, visit [http://community.count.ly](http://community.count.ly "Countly Community Forum").
101+
We are on [Twitter](http://twitter.com/gocountly), [Facebook](https://www.facebook.com/Countly) and [LinkedIn](https://www.linkedin.com/company/countly) if you would like to keep up with Countly related updates.

0 commit comments

Comments
 (0)