Skip to content

Commit 976682b

Browse files
readme (#60)
* readme * Update README.md Co-authored-by: ArtursKadikis <kadikis.arturs@gmail.com>
1 parent 18b0447 commit 976682b

1 file changed

Lines changed: 28 additions & 76 deletions

File tree

README.md

Lines changed: 28 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,41 @@
1-
# Countly NodeJS SDK
2-
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/e68f25fa4a9b4990bdb213554901728b)](https://www.codacy.com/app/ar2rsawseen/countly-sdk-nodejs?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Countly/countly-sdk-nodejs&amp;utm_campaign=Badge_Grade)
1+
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/ed5f07ef6f8b4503ac01b2dab190de01)](https://www.codacy.com/gh/Countly/countly-sdk-nodejs/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Countly/countly-sdk-nodejs&amp;utm_campaign=Badge_Grade)
32
[![npm version](https://badge.fury.io/js/countly-sdk-nodejs.svg)](https://badge.fury.io/js/countly-sdk-nodejs)
43
[![Inline docs](https://inch-ci.org/github/Countly/countly-sdk-nodejs.svg?branch=master)](https://inch-ci.org/github/Countly/countly-sdk-nodejs)
54

6-
## What's Countly?
7-
[Countly](https://count.ly) is an innovative, real-time, open source mobile & [web analytics](https://count.ly/web-analytics), [rich push notifications](https://count.ly/push-notifications)
8-
and [crash reporting](https://count.ly/crash-reports) platform powering more than 2500 web sites and 14000 mobile applications as of 2017 Q3.
9-
It collects data from mobile phones, tablets, Apple Watch and other internet-connected devices, and visualizes this information to analyze application usage and end-user behavior.
10-
11-
With the help of [Javascript SDK](https://github.com/countly/countly-sdk-web), Countly is a web analytics platform with features on par with mobile SDKs. For more information about web analytics capabilities, [see this link](https://count.ly/web-analytics).
12-
13-
There are two parts of Countly: the server that collects and analyzes data, and an SDK (mobile, web or desktop) that sends this data. This repository includes Countly Community Edition (server side). For more information other versions (e.g Enterprise Edition), see [comparison of different Countly editions](https://count.ly/compare)
14-
15-
* **Slack user?** [Join our Slack community](https://slack.count.ly/)
16-
* **Questions?** [Ask in our Community forum](https://support.count.ly/hc/en-us/community/topics)
17-
18-
## About
19-
20-
This repository includes the Countly NodeJS SDK.
21-
22-
Need help? See [Countly SDK for NodeJS](https://support.count.ly/hc/en-us/articles/360037442892-NodeJS-SDK) SDK integration at [Countly Resources](https://support.count.ly/hc/en-us) or [Countly NodeJS SDK Documentation](https://countly.github.io/countly-sdk-nodejs/)
23-
24-
## How to get Countly NodeJS SDK?
25-
26-
Currently in testing phase
27-
28-
```shell
29-
npm install countly-sdk-nodejs
30-
```
31-
32-
or
33-
34-
```shell
35-
yarn add countly-sdk-nodejs
36-
```
37-
38-
## How to use Countly NodeJS SDK?
5+
# Countly NodeJS SDK
396

40-
```JS
41-
var Countly = require('countly-sdk-nodejs');
42-
43-
Countly.init({
44-
app_key: "{YOUR-API-KEY}",
45-
url: "https://try.count.ly/",
46-
debug: true
47-
});
48-
49-
50-
Countly.begin_session();
51-
52-
Countly.add_event({
53-
"key": "in_app_purchase",
54-
"count": 3,
55-
"sum": 2.97,
56-
"dur": 1000,
57-
"segmentation": {
58-
"app_version": "1.0",
59-
"country": "Turkey"
60-
}
61-
});
62-
```
7+
This repository contains the Countly NodeJS SDK, which can be integrated into NodeJS running device or server. The Countly NodeJS SDK is intended to be used with [Countly Community Edition](https://github.com/Countly/countly-server) or [Countly Enterprise Edition](https://count.ly/product).
8+
## What is Countly?
9+
[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),
10+
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.
6311

64-
More information is available at [https://support.count.ly/hc/en-us/articles/360037442892-NodeJS-SDK](https://support.count.ly/hc/en-us/articles/360037442892-NodeJS-SDK)
12+
Track, measure, and take action - all without leaving Countly.
6513

66-
### Other Github resources
14+
* **Slack user?** [Join our Slack Community](https://slack.count.ly)
15+
* **Questions or feature requests?** [Post in our Community Forum](https://support.count.ly/hc/en-us/community/topics)
16+
* **Looking for the Countly Server?** [Countly Community Edition repository](https://github.com/Countly/countly-server)
17+
* **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)
6718

68-
Check Countly Server source code here:
19+
## Integrating Countly SDK in your projects
6920

70-
* [Countly Server](https://github.com/Countly/countly-server)
21+
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/360037442892-NodeJS).
7122

72-
There are also other Countly SDK repositories below:
23+
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/360037442892-NodeJS#adding-the-sdk-to-the-project).
7324

74-
* [Countly iOS SDK](https://github.com/Countly/countly-sdk-ios)
75-
* [Countly Android SDK](https://github.com/Countly/countly-sdk-android)
76-
* [Countly Windows Phone SDK](https://github.com/Countly/countly-sdk-windows-phone)
77-
* [Countly Web SDK](https://github.com/Countly/countly-sdk-web)
78-
* [Countly Appcelerator Titanium SDK](https://github.com/euforic/Titanium-Count.ly) (Community supported)
79-
* [Countly Unity3D SDK](https://github.com/Countly/countly-sdk-unity) (Community supported)
25+
You can reach minimal integration info for your project from [this section of the documentation](https://support.count.ly/hc/en-us/articles/360037442892-NodeJS#minimal-setup).
8026

81-
### How can I help you with your efforts?
27+
This SDK supports the following features:
28+
* [Analytics](https://support.count.ly/hc/en-us/articles/4431589003545-Analytics)
29+
* [User Profiles](https://support.count.ly/hc/en-us/articles/4403281285913-User-Profiles)
30+
* [Crash Reports](https://support.count.ly/hc/en-us/articles/4404213566105-Crashes-Errors)
31+
* [A/B Testing](https://support.count.ly/hc/en-us/articles/4416496362393-A-B-Testing-)
32+
* [Performance Monitoring](https://support.count.ly/hc/en-us/articles/4734457847705-Performance)
8233

83-
Glad you asked. We need ideas, feedbacks and constructive comments. All your suggestions will be taken care with upmost importance. We are on [Twitter](https://twitter.com/gocountly) and [Facebook](https://www.facebook.com/Countly) if you would like to keep up with our fast progress!
34+
## Security
35+
Security is very important to us. If you discover any issue regarding security, please disclose the information responsibly by sending an email to security@count.ly and **not by creating a GitHub issue**.
8436

85-
If you like Countly, why not use one of our badges and give a link back to us, so others know about this wonderful platform?
37+
## Badges
38+
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?
8639

8740
<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>
8841

@@ -96,8 +49,7 @@ If you like Countly, why not use one of our badges and give a link back to us, s
9649
<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>
9750
```
9851

99-
### Support
100-
101-
For community support page, see [https://support.count.ly/hc/en-us/community/topics](https://support.count.ly/hc/en-us/community/topics "Countly Support").
52+
## How can I help you with your efforts?
53+
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).
10254

103-
[![NPM](https://nodei.co/npm/countly-sdk-nodejs.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/countly-sdk-nodejs/)
55+
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)