Package definition and documentation kernel

This commit is contained in:
Jarek Rozanski 2023-03-09 11:44:47 +00:00
parent 98be9f76ac
commit 8e400e1b62
6 changed files with 87 additions and 0 deletions

12
.editorconfig Normal file
View file

@ -0,0 +1,12 @@
root = true
[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
[*.md]
trim_trailing_whitespace = false

44
README.md Normal file
View file

@ -0,0 +1,44 @@
| :exclamation: This plugin in pre-release stage |
|-------------------------------------------------|
# Wide Angle Analytics for Vue.js
Enable **privacy-friendly** web analytics in your Vue.js 3.x application with our official plugin.
[Wide Angle Analytics](https://wideangle.co) is powerful, strictly-GDPR compliant Google Analytics alternative.
# How to get started
You can enable Wide Angle Analytics in your Vue.js projects in just few steps. No complex configuration needed as our sane defaults give you reliable and privacy centric deployment out of the box.
1. Go to [Wide Angle](https://wideangle.co) website, create an account. You can create free 14-day trail. No Credit Card is required. [Learn more.](https://wideangle.co/documentation/create-account)
2. [Create new Site](https://wideangle.co/documentation/create-and-configure-site) and activate it.
3. Install `wideangle-vuejs` plugin in your Vue application.
```npm install wideangle-vuejs```
4. Enable and configure plugin.
```javascript
import WideAnglePlugin from 'wideangle-vuejs'
app.use(WideAnglePlugin)
```
# Configuring Wide Angle Analytics plugin
:construction_worker: * TODO*
# Usage
## Tracking Pageviews
## Tracking Events
### Tracking Clicks
### Tracking Downloads
### Tracking Custom Actions

7
index.js Normal file
View file

@ -0,0 +1,7 @@
export default {
install: (app, options) => {
}
}

20
package.json Normal file
View file

@ -0,0 +1,20 @@
{
"name": "wideangle-vuejs",
"version": "0.0.1",
"description": "Wide Angle Analytics web analytics Plugin for Vue.js 3.x",
"homepage": "https://wideangle.co",
"repository": "github:inputobjects/wideangle-vuejs",
"main": "index.js",
"scripts": {
},
"keywords": [
"wide angle analytics",
"web analytics",
"vue.js",
"vuejs",
"plugin",
"vuejs plugin"
],
"author": "Wide Angle Analytics <developers@wideangle.co>",
"license": "Apache-2.0"
}

3
src/index.js Normal file
View file

@ -0,0 +1,3 @@
import WideAngle from './wideangle.js';
export default WideAngle;

1
src/wideangle.js Normal file
View file

@ -0,0 +1 @@
export default {}