Skip to content

Commit f443029

Browse files
feat/vue readme
1 parent c00356b commit f443029

2 files changed

Lines changed: 37 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ A set of SDKS for integration with the [Traceo Platform](https://github.com/trac
55
# Platforms
66
This repository contains all the SDKs needed for integration in Javascript/Typescript projects. Detailed instructions for the SDK implementation process can be found in the individual README for each SDK.
77

8-
- [`@traceo-sdk/node`](https://github.com/traceo-dev/traceo-sdk/tree/develop/packages/node): SDK for NodeJS.
9-
- [`@traceo-sdk/react`](https://github.com/traceo-dev/traceo-sdk/tree/develop/packages/react): SDK for ReactJS.
8+
- [`@traceo-sdk/node`](https://github.com/traceo-dev/traceo-sdk/tree/develop/packages/node): NodeJS.
9+
- [`@traceo-sdk/react`](https://github.com/traceo-dev/traceo-sdk/tree/develop/packages/react): React.
10+
- [`@traceo-sdk/react`](https://github.com/traceo-dev/traceo-sdk/tree/develop/packages/vue): Vue.
1011

1112
# Other
1213
- [`@traceo-sdk/browser`](https://github.com/traceo/traceo-sdk/tree/develop/packages/browser): A package that contains common logic used by all SDKs running in the browser.

packages/vue/README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,34 @@
1-
# Traceo SDK for Vue
1+
# Traceo SDK for Vue
2+
3+
Library for integration with [Traceo Platform](https://github.com/traceo-dev/traceo).
4+
5+
### Installation
6+
To install this SDK add this package to your project like below:
7+
```
8+
yarn add @traceo-sdk/vue
9+
```
10+
or
11+
```
12+
npm install @traceo-sdk/vue
13+
```
14+
15+
### Usage
16+
To use this SDK initialize `TraceoClient` in your application.
17+
```ts
18+
import { TraceoClient } from "@traceo-sdk/vue";
19+
20+
const app = createApp({ ... });
21+
22+
new TraceoClient({
23+
appId: <your_application_id>,
24+
apiKey: <app_api_key>,
25+
url: <you_traceo_instance_url>
26+
});
27+
28+
// your code
29+
30+
app.mount("#app");
31+
```
32+
33+
## Support
34+
Feel free to create Issues, Pull Request and Discussion. If you want to contact with the developer working on this package click [here](mailto:piotr.szewczyk.software@gmail.com).

0 commit comments

Comments
 (0)