Skip to content

Commit

Permalink
remove formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
sayan-rudder committed Oct 11, 2019
1 parent a88d264 commit 2fd3b19
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions rudder-client-javascript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,25 @@ This repo contains **builds** and **source-code** to integrate with your web-app

Under the **analytics** folder, navigate to **dist** where you can find the minified and unminified versions of the sdk. There are two builds for working with browser based applications and node applications, mainly **browser.js** and **node.js**.

Few sample usage of the sdk can be found under **tests** directory for vanilla html, Angular, and node integrations.
Few sample usage of the sdk can be found under **tests** directory for vanilla html, Angular, and node integrations.

## Code Structure

- The whole code development is under the **analytics** folder.
- The whole code development is under the **analytics** folder.
- **analytics.js** handles the core functionality for tapping your **identify**, **page** and **track** calls.
- **integrations** contains the native loading and invocation of different destinations.
- **HubSpot** and **Google Analytics** integrations have been in development recently.

**\*We try to support both browser and node versions of these integrations. It may so happen that integrations doesn't have a node sdk, in that case routing data through our **data-plane\*_ is one of the options to send data to these destinations_
- **integrations** contains the native loading and invocation of different destinations.
- **HubSpot** and **Google Analytics** integrations have been in development recently.

***We try to support both browser and node versions of these integrations. It may so happen that integrations doesn't have a node sdk, in that case routing data through our **data-plane** is one of the options to send data to these destinations*
- The **dist** folder contains the minified and unminified versions of the sdk.
- **tests** contains various flavours for how to use the sdk in applications
- We use _rollup_ and _babel_ for transpiling and generating the specific builds.
- We use *rollup* and *babel* for transpiling and generating the specific builds.

## Contribute

One can start adding integrations like _Mixpanel_, _Facebook ads_ and others for sending data through their _js_ and _node_ sdks.
One can start adding integrations like *Mixpanel*, *Facebook ads* and others for sending data through their *js* and *node* sdks.

For building the sdk,

- Look for run scripts in the _package.json_ file for getting browser and node specific builds.
- For adding or removing integrations, modify the _imports_ in _index.js_ under **integrations** folder.
- Look for run scripts in the *package.json* file for getting browser and node specific builds.
- For adding or removing integrations, modify the *imports* in *index.js* under **integrations** folder.

0 comments on commit 2fd3b19

Please sign in to comment.