Skip to content

Commit 3691909

Browse files
authored
markdown (#58)
1 parent 4b34a22 commit 3691909

5 files changed

Lines changed: 70 additions & 15 deletions

File tree

.markdownlint.json

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
{
2+
"MD001": true,
3+
"MD002": false,
4+
"MD003": true,
5+
"MD004": true,
6+
"MD005": true,
7+
"MD006": true,
8+
"MD007": { "indent": 2 },
9+
"MD009": false,
10+
"MD010": false,
11+
"MD011": true,
12+
"MD012": { "maximum": 1 },
13+
"MD013": { "line_length": 300 },
14+
"MD014": false,
15+
"MD018": true,
16+
"MD019": true,
17+
"MD020": true,
18+
"MD021": true,
19+
"MD022": false,
20+
"MD023": true,
21+
"MD024": true,
22+
"MD025": true,
23+
"MD026": true,
24+
"MD027": true,
25+
"MD028": true,
26+
"MD029": true,
27+
"MD030": true,
28+
"MD031": true,
29+
"MD032": false,
30+
"MD033": false,
31+
"MD034": false,
32+
"MD035": true,
33+
"MD036": true,
34+
"MD037": true,
35+
"MD038": true,
36+
"MD039": true,
37+
"MD040": true,
38+
"MD041": false,
39+
"MD042": true,
40+
"MD043": false,
41+
"MD044": true,
42+
"MD045": true,
43+
"MD046": true,
44+
"MD047": true,
45+
"MD048": true,
46+
"MD049": true,
47+
"MD050": true,
48+
"MD051": true,
49+
"MD052": true,
50+
"MD053": true
51+
}
52+

.markdownlintignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/node_modules/

CHANGELOG.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@
88
## 21.11.0
99
- !! Major breaking change !! Changing device ID without merging will now clear the current consent. Consent has to be given again after performing this action.
1010
- ! Minor breaking change ! Multiple values now have a default limit adjustable at initialization:
11-
- Maximum size of all string keys is now 128 characters by default.
12-
- Maximum size of all values in key-value pairs is now 256 characters by default.
13-
- Maximum amount of segmentation in one event is mow 30 key-value pairs by default.
14-
- Maximum amount of breadcrumbs that can be recorded at once is now 100 by default.
15-
- Maximum stack trace lines per thread is now 30 by default.
16-
- Maximum stack trace line length is now 200 by default.
11+
- Maximum size of all string keys is now 128 characters by default.
12+
- Maximum size of all values in key-value pairs is now 256 characters by default.
13+
- Maximum amount of segmentation in one event is mow 30 key-value pairs by default.
14+
- Maximum amount of breadcrumbs that can be recorded at once is now 100 by default.
15+
- Maximum stack trace lines per thread is now 30 by default.
16+
- Maximum stack trace line length is now 200 by default.
1717
- ! Minor breaking change ! After initialization, the logging/debugging mode can only be changed with `Countly.setLoggingEnabled` instead of `Countly.debug` now.
1818
- When recording internal events with 'add_event', the respective feature consent will now be checked instead of just the 'events' consent.
1919
- Fixed a bug where the SDK throws a `Bulk user storage exception` due to a missing folder

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Countly NodeJS SDK
22
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/e68f25fa4a9b4990bdb213554901728b)](https://www.codacy.com/app/ar2rsawseen/countly-sdk-nodejs?utm_source=github.com&utm_medium=referral&utm_content=Countly/countly-sdk-nodejs&utm_campaign=Badge_Grade) [![npm version](https://badge.fury.io/js/countly-sdk-nodejs.svg)](https://badge.fury.io/js/countly-sdk-nodejs) [![Inline docs](https://inch-ci.org/github/Countly/countly-sdk-nodejs.svg?branch=master)](https://inch-ci.org/github/Countly/countly-sdk-nodejs)
33

4-
54
## What's Countly?
65
[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) and [crash reporting](https://count.ly/crash-reports) platform powering more than 2500 web sites and 14000 mobile applications as of 2017 Q3. 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.
76

@@ -28,6 +27,7 @@ or
2827
yarn add countly-sdk-nodejs
2928

3029
## How to use Countly NodeJS SDK?
30+
3131
```
3232
var Countly = require('countly-sdk-nodejs');
3333
@@ -51,22 +51,23 @@ Countly.add_event({
5151
}
5252
});
5353
```
54+
5455
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)
5556

5657
### Other Github resources ###
5758

5859
Check Countly Server source code here:
5960

60-
- [Countly Server](https://github.com/Countly/countly-server)
61+
* [Countly Server](https://github.com/Countly/countly-server)
6162

6263
There are also other Countly SDK repositories below:
6364

64-
- [Countly iOS SDK](https://github.com/Countly/countly-sdk-ios)
65-
- [Countly Android SDK](https://github.com/Countly/countly-sdk-android)
66-
- [Countly Windows Phone SDK](https://github.com/Countly/countly-sdk-windows-phone)
67-
- [Countly Web SDK](https://github.com/Countly/countly-sdk-web)
68-
- [Countly Appcelerator Titanium SDK](https://github.com/euforic/Titanium-Count.ly) (Community supported)
69-
- [Countly Unity3D SDK](https://github.com/Countly/countly-sdk-unity) (Community supported)
65+
* [Countly iOS SDK](https://github.com/Countly/countly-sdk-ios)
66+
* [Countly Android SDK](https://github.com/Countly/countly-sdk-android)
67+
* [Countly Windows Phone SDK](https://github.com/Countly/countly-sdk-windows-phone)
68+
* [Countly Web SDK](https://github.com/Countly/countly-sdk-web)
69+
* [Countly Appcelerator Titanium SDK](https://github.com/euforic/Titanium-Count.ly) (Community supported)
70+
* [Countly Unity3D SDK](https://github.com/Countly/countly-sdk-unity) (Community supported)
7071

7172
### How can I help you with your efforts?
7273

@@ -86,5 +87,4 @@ If you like Countly, why not use one of our badges and give a link back to us, s
8687

8788
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").
8889

89-
9090
[![NPM](https://nodei.co/npm/countly-sdk-nodejs.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/countly-sdk-nodejs/)

package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
"scripts": {
1212
"lint": "eslint **/*.js",
1313
"lint:fix": "npm run lint -- --fix",
14+
"lintMD": "markdownlint **/*.md --fix",
1415
"docs": "node_modules/.bin/jsdoc lib/countly.js lib/countly-bulk.js lib/countly-bulk-user.js README.md -c jsdoc_conf.json -d docs",
1516
"pretest": "eslint --ignore-path .eslintignore .",
1617
"test": "mocha --timeout 180000 test/tests_*.js --exit --allow-uncaught"
@@ -35,6 +36,7 @@
3536
"eslint": "^6.8.0",
3637
"eslint-config-airbnb-base": "^14.1.0",
3738
"eslint-plugin-import": "^2.20.1",
39+
"markdownlint": "^0.26.0",
3840
"mocha": "*",
3941
"jsdoc": "*",
4042
"docdash": "*"

0 commit comments

Comments
 (0)