Skip to content

Commit 39317da

Browse files
authored
docs: prepare for release (#2)
* Update README.md * Update ci.yml * Update README.md * Update README.md * Fix TOC * Update README.md * Update README.md * Update README.md * Update README.md * Update release.yml * Use cache
1 parent 4d09ebe commit 39317da

File tree

3 files changed

+33
-35
lines changed

3 files changed

+33
-35
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ on:
77
branches:
88
- '**'
99
env:
10-
NODE_VERSION: 14.16.1
10+
NODE_VERSION: 14.19.0
1111
jobs:
1212
check-circular:
1313
name: Circular Dependencies

.github/workflows/release.yml

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,19 @@ jobs:
77
publish:
88
runs-on: ubuntu-latest
99
steps:
10-
- uses: actions/checkout@v1
11-
- uses: actions/setup-node@v1
10+
- uses: actions/checkout@v2
11+
- uses: actions/setup-node@v2
1212
with:
13-
node-version: 10
14-
- run: npm install
15-
- run: npm test
16-
- uses: JS-DevTools/npm-publish@v1
13+
node-version: '14.x'
14+
registry-url: 'https://registry.npmjs.org'
15+
- name: Cache Node.js modules
16+
uses: actions/cache@v2
1717
with:
18-
token: ${{ secrets.NPM_TOKEN }}
18+
path: ~/.npm
19+
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
20+
restore-keys: |
21+
${{ runner.os }}-node-
22+
- run: npm ci
23+
- run: npm publish
24+
env:
25+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

Lines changed: 18 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
# parse-server-any-analytics-adapter
22
<!-- netreconlab/parse-server-any-analytics-adapter -->
33

4+
[![npm version](https://badge.fury.io/js/parse-server-any-analytics-adapter.svg)](https://badge.fury.io/js/parse-server-any-analytics-adapter)
45
[![ci](https://github.com/netreconlab/parse-server-any-analytics-adapter/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/netreconlab/parse-server-any-analytics-adapter/actions/workflows/ci.yml)
56
[![release](https://github.com/netreconlab/parse-server-any-analytics-adapter/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/netreconlab/parse-server-any-analytics-adapter/actions/workflows/release.yml)
6-
[![npm version](https://badge.fury.io/js/parse-server-any-analytics-adapter.svg)](https://badge.fury.io/js/parse-server-any-analytics-adapter)
77
[![codecov](https://codecov.io/gh/netreconlab/parse-server-any-analytics-adapter/branch/main/graph/badge.svg)](https://codecov.io/gh/netreconlab/parse-server-any-analytics-adapter)
8-
<!-- [![vulnerabilities](https://snyk.io/test/github/netreconlab/parse-server-any-analytics-adapter/badge.svg)](https://snyk.io/test/github/netreconlab/parse-server-any-analytics-adapter) -->
8+
[![vulnerabilities](https://snyk.io/test/github/netreconlab/parse-server-any-analytics-adapter/badge.svg)](https://snyk.io/test/github/netreconlab/parse-server-any-analytics-adapter)
99
[![dependency up-to-date](https://img.shields.io/librariesio/release/npm/parse-server-any-analytics-adapter)](https://libraries.io/npm/parse-server-any-analytics-adapter)
1010
[![weekly downloads](https://img.shields.io/npm/dw/parse-server-any-analytics-adapter)](https://www.npmjs.com/package/parse-server-any-analytics-adapter)
11+
[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/netreconlab/parse-server-any-analytics-adapter/#license)
1112

13+
This library allow a [Parse Server](https://github.com/parse-community/parse-server) to leverage the [Analytics](https://github.com/DavidWells/analytics) library to connect to any [3rd party analytics](https://getanalytics.io/plugins/) tool :chart:.
1214

13-
This library allows Parse Servers to leverage the [Analytics library](https://github.com/DavidWells/analytics) to connect to any [3rd party analytics](https://getanalytics.io/plugins/) tool. :chart:
15+
# Table of Contents <!-- omit in toc -->
1416

15-
## Table of Contents <!-- omit in toc -->
17+
- [Usage](#usage)
18+
- [Server](#server)
19+
- [Client](#client)
1620

17-
- [Usage](https://github.com/netreconlab/parse-server-any-analytics-adapter/edit/adapter/README.md#usage)
18-
- [Server](https://github.com/netreconlab/parse-server-any-analytics-adapter/edit/adapter/README.md#server)
19-
- [Client](https://github.com/netreconlab/parse-server-any-analytics-adapter/edit/adapter/README.md#client)
2021

21-
22-
## Usage
23-
#### Server
22+
# Usage
23+
## Server
2424

2525
```javascript
2626
import AnyAnalyticsAdapter from 'parse-server-any-analytics-adapter'
@@ -29,16 +29,16 @@ import customerIo from '@analytics/customerio'
2929

3030
/* Initialize AnyAnalytics with with any and all 3rd party analytics of your choosing. */
3131
const anyAnalytics = AnyAnalyticsAdapter({
32-
app: 'my-app-name', // Name of site / app
33-
version: 100, // Version of your app
34-
plugins: [
32+
app: 'my-app-name', /* Name of site / app */
33+
version: 100, /* Version of your app */
34+
plugins: [ /* Array of analytics plugins */
3535
googleAnalytics({
3636
trackingId: 'UA-121991291',
3737
}),
3838
customerIo({
3939
siteId: '123-xyz'
4040
})
41-
] // Array of analytics plugins
41+
]
4242
})
4343

4444
/* Initialize parse server */
@@ -53,23 +53,14 @@ const api = new ParseServer({
5353
});
5454

5555
/* Finish mounting your Parse Server */
56-
const app = express();
57-
58-
app.use('/public', express.static(path.join(__dirname, '/public')));
59-
60-
const mountPath = process.env.PARSE_SERVER_MOUNT_PATH || '/parse';
61-
app.use(mountPath, api.app);
62-
63-
app.get('/', function(req, res) {
64-
res.status(200).send('I dream of being a website. Please start the parse-server repo on GitHub!');
65-
});
56+
...
6657
```
6758

68-
#### Client
59+
## Client
6960

70-
You can use REST or any Parse SDK client that has the ability to use Parse Analytics such as the [Parse-Swift SDK](https://github.com/parse-community/Parse-Swift/blob/main/ParseSwift.playground/Pages/16%20-%20Analytics.xcplaygroundpage/Contents.swift).
61+
You can use [REST](https://docs.parseplatform.org/rest/guide/#analytics) or any [Parse SDK](https://parseplatform.org/#sdks) that has the ability to send Parse Analytics such as the [Parse-Swift SDK](https://github.com/parse-community/Parse-Swift/blob/main/ParseSwift.playground/Pages/16%20-%20Analytics.xcplaygroundpage/Contents.swift):
7162

72-
```javascript
63+
```swift
7364
//: To track when the app has been opened, do the following.
7465
ParseAnalytics.trackAppOpened { result in
7566
switch result {

0 commit comments

Comments
 (0)