Skip to content

Commit

Permalink
Merge pull request #1 from utip/floSoX-patch-1
Browse files Browse the repository at this point in the history
Use classic README template
  • Loading branch information
GuillaumeLe authored Oct 19, 2020
2 parents edac191 + cd22b08 commit ce6acb6
Showing 1 changed file with 25 additions and 8 deletions.
33 changes: 25 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
# Vue Twitch extension plugin

#### Table of Contents

1. [Description](#description)
2. [Setup](#setup)
3. [Usage](#usage)
4. [Development](#development)
5. [Contributors](#contributors)

## Description

Vue Twitch extension plugin is Vue.js plugin made to help you to develop Twitch extension.

## Installation:
## Setup
This package is published on Github packages.
Before installing it you need to add a `.npmrc` file in your project that contain:
```
Expand All @@ -27,12 +37,10 @@ import TwitchExtensionPlugin from 'vue-twitch-extension-plugin';
Vue.use(TwitchExtensionPlugin)
```

## Usage:

## Usage
The twitch extension object describe in [Twitch documentation references](https://dev.twitch.tv/docs/extensions/reference#javascript-helper) is available in all your component with `this.$twitch.ext`

### Configuration service:

### Configuration service
Twitch help user to manage the configuration of the extension with their [Configuration service](https://dev.twitch.tv/docs/extensions/building#using-the-configuration-service)

The configuration is available in the `this.$twitch.configuration` object:
Expand All @@ -59,8 +67,17 @@ this.$twitch.publishConfig({key: 'value'}, segment = 'broadcaster', version = '1
```

### Twitch context

The Twitch context (theme, language, current game ...) is available inside your component with:
The Twitch context (theme, language, current game...) is available inside your component with:
```js
this.$twitch.context
```
```

## Development

[uTip](https://utip.io)'s repositories are open projects, and community contributions are essential for keeping them great.

[Fork this repo on GitHub](https://github.com/utip/vue-twitch-extension-plugin/fork)

## Contributors

The list of contributors can be found at: https://github.com/utip/vue-twitch-extension-plugin/graphs/contributors

0 comments on commit ce6acb6

Please sign in to comment.