Skip to content

Commit

Permalink
Update title header and clean up warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
dylanfrankcom committed Dec 19, 2022
1 parent e1ecf60 commit 0c3f2ea
Showing 1 changed file with 21 additions and 22 deletions.
43 changes: 21 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,44 @@
# docusaurus-plugin-moesif
# Moesif Docusaurus Plugin

A Docusaurus plugin for [Moesif API Analytics](https://www.moesif.com/) built using `moesif-browser-js`.
A Docusaurus plugin for [Moesif API Analytics](https://www.moesif.com/) built using `moesif-browser-js`.

For full documentation and configuration, see [moesif-browser-js docs](https://www.moesif.com/docs/client-integration/browser-js/)

The SDK automatically collects useful context from a user's device including any marketing attribution, device type, and location information and stores in the user and/or company profile in Moesif. You can add additional customer properties such as user email and company domain via the [identifyUser()](https://www.moesif.com/docs/client-integration/browser-js/#identifying-users) and [identifyCompany()](https://www.moesif.com/docs/client-integration/browser-js/#identifying-companies) methods.


> The below Diagram shows how both `docusaurus-plugin-moesif` and a Moesif [server integration](https://www.moesif.com/docs/server-integration/) to track both web and API traffic made by a customer.
> The below Diagram shows how both `docusaurus-plugin-moesif` and a Moesif [server integration](https://www.moesif.com/docs/server-integration/) to track both web and API traffic made by a customer.
![Diagram of Moesif API monitoring and Docusaurus architecture](https://www.moesif.com/docs/images/docs/client-integration/moesif-arch-docusaurus.png)

## How to install

1. Install `docusaurus-plugin-moesif`

`npm install --save docusaurus-plugin-moesif`
`npm install --save docusaurus-plugin-moesif`

2. Add plugin to `docusaurus.config.js`

```javascript
module.exports = {
plugins: ['docusaurus-plugin-moesif'],
themeConfig: {
moesif: {
applicationId: 'Your Moesif Application Id',
// Add other Moesif options here.
},
},
};
```
```javascript
module.exports = {
plugins: ['docusaurus-plugin-moesif'],
themeConfig: {
moesif: {
applicationId: 'Your Moesif Application Id',
// Add other Moesif options here.
},
},
};
```

3. Test it works

Because the plugin is disabled when `NODE_ENV` is set to development, you'll want to create a production build:
Because the plugin is disabled when `NODE_ENV` is set to development, you'll want to create a production build:
```
npm run build
```bash
npm run build
npm run serve
```
npm run serve
```
## How to use
Expand All @@ -62,4 +61,4 @@ window.moesif.identifyUser("12345", {
## Configuration Options
For full list of configuration options, [see this page](https://www.moesif.com/docs/client-integration/browser-js/#configuration-options).
For full list of configuration options, [see this page](https://www.moesif.com/docs/client-integration/browser-js/#configuration-options).

0 comments on commit 0c3f2ea

Please sign in to comment.