Skip to content

Commit e2016ce

Browse files
authored
[SDK 726] Readme.md updated (#71)
* - Badges added - C++ doc url added * section moved to higher place.
1 parent acb2688 commit e2016ce

File tree

1 file changed

+40
-1
lines changed

1 file changed

+40
-1
lines changed

README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,16 @@ This repository contains the portable Countly C++ SDK.
1111
* **Slack user?** [Join our Slack community](http://slack.count.ly:3000/)
1212
* **Questions?** [Ask in our Community forum](http://community.count.ly)
1313

14+
## About
15+
16+
This repository includes the Countly C++ SDK.
17+
18+
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).
19+
20+
## Security
21+
22+
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**.
23+
1424
## Dependencies and building
1525

1626
Countly C++ SDK has been designed to work with very few dependencies in order to be available on most platforms.
@@ -90,4 +100,33 @@ To run unit tests associated with 'SQLITE' and 'Custom SHA-256' build executable
90100

91101
``` shell
92102
cmake -DCOUNTLY_BUILD_TESTS=1 -DCOUNTLY_USE_SQLITE=1 -DCOUNTLY_USE_CUSTOM_SHA256=1 -B build
93-
```
103+
```
104+
## Other Github resources
105+
106+
This SDK needs one of the following Countly Editions to work:
107+
108+
* Countly Community Edition, [downloadable from Github](https://github.com/Countly/countly-server)
109+
* [Countly Enterprise Edition](http://count.ly/product)
110+
111+
For more information about Countly Enterprise Edition, see [comparison of different Countly editions](https://count.ly/compare/)
112+
113+
There are also other Countly SDK repositories (both official and community supported) on [Countly resources](http://resources.count.ly/v1.0/docs/downloading-sdks).
114+
115+
## How can I help you with your efforts?
116+
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!
117+
118+
## Badges
119+
120+
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?
121+
122+
<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>
123+
124+
<a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/dark.svg" alt="Countly - Product Analytics" /></a>
125+
126+
<a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/light.svg?v2" alt="Countly - Product Analytics" /></a>
127+
128+
<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>
129+
130+
### Support
131+
132+
For Community support, visit [http://community.count.ly](http://community.count.ly "Countly Community Forum").

0 commit comments

Comments
 (0)