Skip to content
This repository has been archived by the owner on Sep 16, 2024. It is now read-only.

chore(docs): update sdk readme #330

Merged
merged 1 commit into from
Oct 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions packages/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
<img width="150" style="border-radius:75px;" src="https://res.cloudinary.com/dfcnic8wq/image/upload/v1673932396/Revert/Revert_logo_x5ysgh.png"/>
<h1 align="center"><b>Revert</b></h1>
<p align="center">
Universal API for CRMs
Open-source unified API for product integrations
<br />
</p>

# @revertdotdev/revert-react

## Overview

Revert is the fastest way to integrate with your customer's CRMs with a single set of APIs & SDKs.
Revert is the fastest way to integrate with your customer's tools with a single set of APIs & SDKs.

This package contains the React sdk with the following:

Expand All @@ -27,7 +27,7 @@ yarn add @revertdotdev/revert-react

### Usage

1. Adding the `<RevertConnect>` component will instantly give your app a way for your users to connect their CRMs by opening our Modal on clicking where they will be a able to choose & connect their CRM.
1. Adding the `<RevertConnect>` component will instantly give your app a way for your users to connect their tools by opening our Modal on clicking where they will be a able to choose & connect their 3rd party tool.

```javascript
function App() {
Expand Down Expand Up @@ -64,15 +64,16 @@ return (
...props.style,
}}
>
{props.children || 'Connect your CRM'}
{props.children || 'Connect your tool'}
</button>
);
```

You can also pass in the `integrationId` inside the `open()` method above to directly open the integration you are interested in. These are the integration IDs that are currently supported:
- `open('hubspot')`
- `open('zohocrm')`
- `open('sfdc')`

- `open('hubspot')`
- `open('zohocrm')`
- `open('sfdc')`

### Support

Expand Down
29 changes: 15 additions & 14 deletions packages/vue/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
<img width="150" style="border-radius:75px;" src="https://res.cloudinary.com/dfcnic8wq/image/upload/v1673932396/Revert/Revert_logo_x5ysgh.png"/>
<h1 align="center"><b>Revert</b></h1>
<p align="center">
Universal API for CRMs
Open-source unified API for product integrations
<br />
</p>

# @revertdotdev/revert-vue

## Overview

Revert is the fastest way to integrate with your customer's CRMs with a single set of APIs & SDKs.
Revert is the fastest way to integrate with your customer's tools with a single set of APIs & SDKs.

This package contains the Vue sdk with the `RevertConnectVue` component.

Expand All @@ -24,7 +24,7 @@ yarn add @revertdotdev/revert-vue

### Usage

1. Adding the `<RevertConnectVue>` component will instantly give your app a way for your users to connect their CRMs by opening our Modal on clicking where they will be a able to choose & connect their CRM.
1. Adding the `<RevertConnectVue>` component will instantly give your app a way for your users to connect their tools by opening our Modal on clicking where they will be a able to choose & connect their 3rd party tool.

```javascript
<script>
Expand All @@ -33,7 +33,7 @@ import { RevertConnectVue } from '@revertdotdev/revert-vue'
export default {
name: 'App',
components: {
RevertConnectVue,
RevertConnectVue,
},
data() {
return {
Expand Down Expand Up @@ -62,7 +62,7 @@ import { RevertConnectVue } from '@revertdotdev/revert-vue'
export default {
name: 'App',
components: {
RevertConnectVue,
RevertConnectVue,
},
data() {
return {
Expand All @@ -78,8 +78,8 @@ export default {
borderRadius: '5px',
cursor: 'pointer',
color: '#fff',
},
buttonText: "Connect your CRM"
},
buttonText: "Connect your tool"
};
},
};
Expand Down Expand Up @@ -109,22 +109,23 @@ export default {
</script>
<template>
<div class="container">
<button :disabled="loading || Boolean(error)"
@click="open()"
<button :disabled="loading || Boolean(error)"
@click="open()"
id="revert-connect-button"
:style="{ padding: '10px', outline: 'none', background: 'rgb(39, 45, 192)',
border: '1px solid rgb(39, 45, 192)', borderRadius: '5px',
cursor: 'pointer', color: '#fff' }">
Connect your CRM
Connect your tool
</button>
</div>
</template>
```

You can also pass in the `integrationId` inside the `open()` method above to directly open the integration you are interested in. These are the integration IDs that are currently supported:
- `open('hubspot')`
- `open('zohocrm')`
- `open('sfdc')`
You can also pass in the `integrationId` inside the `open()` method above to directly open the integration you are interested in. These are the integration IDs that are currently supported:

- `open('hubspot')`
- `open('zohocrm')`
- `open('sfdc')`

### Support

Expand Down