Skip to content

Commit f731c7f

Browse files
akoushkeakoushke
committed
feat(readme): write up
1 parent 152b0cc commit f731c7f

File tree

2 files changed

+113
-3
lines changed

2 files changed

+113
-3
lines changed

‎README.md

Lines changed: 111 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,111 @@
1-
### Webex SDK Component Adapter
1+
<h1 align='center' style='border-bottom: none;'>Webex SDK Component Adapter</h1>
2+
<h3 align='center'>Webex adapter to share SDK data with the <a href="https://github.com/webex/components">components</a></h3>
3+
<p align='center'>
4+
<a href='https://circleci.com/gh/webex/sdk-component-adapter'>
5+
<img alt='CircleCI' src='https://circleci.com/gh/webex/sdk-component-adapter.svg?style=shield'>
6+
</a>
7+
<a href='https://www.npmjs.com/package/@webex/sdk-component-adapter'>
8+
<img alt='npm latest version' src='https://img.shields.io/npm/v/@webex/sdk-component-adapter?label=npm%40latest'>
9+
</a>
10+
<a href='#badge'>
11+
<img alt='semantic-release' src='https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg'>
12+
</a>
13+
<a href='https://github.com/webex/sdk-component-adapter/blob/master/LICENSE'>
14+
<img src='https://img.shields.io/npm/l/webex.svg' alt='license'>
15+
</a>
16+
</p>
17+
18+
**Webex SDK Adapter** is a library of adapters to provide live data from [Webex JavaScript SDK](https://github.com/webex/webex-js-sdk) to [Webex Components](https://github.com/webex/components).
19+
20+
## Table of Contents
21+
22+
- [Install](#install)
23+
- [Usage](#usage)
24+
- [Contributing](#contributing)
25+
- [License](#license)
26+
- [Support](#support)
27+
- [Team](#team)
28+
29+
## Install
30+
31+
```bash
32+
npm install --save @webex/components @webex/sdk-component-adapter
33+
```
34+
35+
## Usage
36+
37+
### Components
38+
39+
For more information on how to use **Webex Components**, visit [this page](https://github.com/webex/components/blob/master/README.md).
40+
41+
Putting everything together - SDK adapters and components - this is a simple example of how using a component would look like:
42+
43+
```js
44+
import '@webex/components/dist/webexComponents.css';
45+
46+
import React from 'react';
47+
import ReactDOM from 'react-dom';
48+
import {WebexSDKAdapter} from '@webex/sdk-component-adapter';
49+
import {WebexAvatar} from '@webex/components';
50+
51+
const adapter = new WebexSDKAdapter();
52+
53+
ReactDOM.render(
54+
<WebexDataProvider adapter={adapter} >
55+
<WebexAvatar personId="XYZ" />,
56+
</WebexDataProvider>
57+
document.getElementById('root')
58+
);
59+
```
60+
61+
_Happy Coding!_
62+
63+
## Contributing
64+
65+
We'd love for you to contribute to our source code and to make **Webex SDK Adapter** even better than it is today! Here are some [guidelines](https://github.com/webex/sdk-component-adapter/blob/master/CONTRIBUTING.md) that we'd like you to follow.
66+
67+
### Issues
68+
69+
Please open an [issue](https://github.com/webex/sdk-component-adapter/issues) and we will get to it in an orderly manner.
70+
Please leave as much as information as possible for a better understanding.
71+
72+
### Contributing Code
73+
74+
We are using [Webex Style Guide eslint rule](https://github.com/webex/web-styleguide/tree/master/packages/node_modules/%40webex/eslint-config-react) and [prettier](https://github.com/prettier/prettier) to lint the code style.
75+
You can "prettify" your code before committing via:
76+
77+
```bash
78+
npm run prettier:write
79+
```
80+
81+
### Release Process
82+
83+
There is a list of commit types provided [here](https://github.com/webex/sdk-component-adapter/blob/master/CONTRIBUTING.md#type). However, not all commits trigger our release process.
84+
We are using [semantic-release](https://github.com/semantic-release/semantic-release) to fully automate the version management and package publishing.
85+
By default `semantic-release` uses the [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) and triggers release and publishing based on the following rules:
86+
87+
| Commit | Release type |
88+
| ---------------------------------- | ------------- |
89+
| Commit with type `BREAKING CHANGE` | Major release |
90+
| Commit with type `feat` | Minor release |
91+
| Commit with type `fix` | Patch release |
92+
| Commit with type `perf` | Patch release |
93+
94+
#### Commit linter
95+
96+
We are using [commitlint](https://github.com/conventional-changelog/commitlint) to lintify the commit messages.
97+
Please make sure to choose the appropriate commit [type](https://github.com/webex/sdk-component-adapter/blob/master/CONTRIBUTING.md#type), [scope](https://github.com/webex/sdk-component-adapter/blob/master/CONTRIBUTING.md#scope) and [subject](https://github.com/webex/sdk-component-adapter/blob/master/CONTRIBUTING.md#scope).
98+
99+
## License
100+
101+
[MIT License](https://opensource.org/licenses/MIT)
102+
103+
## Support
104+
105+
For more developer resources, tutorials and support, visit the Webex developer portal, https://developer.webex.com.
106+
107+
## Team
108+
109+
| [![Adam Weeks](https://github.com/adamweeks.png?size=100)](https://github.com/adamweeks) | [![Arash Koushkebaghi](https://github.com/akoushke.png?size=100)](https://github.com/akoushke) | [![Lalli Flores](https://github.com/lalli-flores.png?size=100)](https://github.com/lalli-flores) | [![Timothy Scheuering](https://github.com/InteractiveTimmy.png?size=100)](https://github.com/InteractiveTimmy) | [![David Hoff](https://github.com/harborhoffer.png?size=100)](https://github.com/harborhoffer) | [![Taymoor Khan](https://github.com/taymoork2.png?size=100)](https://github.com/taymoork2) |
110+
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
111+
| [Adam Weeks](https://github.com/adamweeks) | [Arash Koushkebaghi](https://github.com/akoushke) | [Lalli Flores](https://github.com/lalli-flores) | [Timothy Scheuering](https://github.com/InteractiveTimmy) | [David Hoff](https://github.com/harborhoffer) | [Taymoor Khan](https://github.com/taymoork2) |

‎package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{
22
"name": "@webex/sdk-component-adapter",
3-
"version": "1.0.0",
3+
"version": "0.0.0",
44
"scripts": {
55
"build": "rollup -c",
66
"clear": "rm package-lock.json && rm -rf node_modules",
77
"prettier": "prettier \"src/**/!(static)/**/*.*(js|jsx)\"",
88
"prettier:write": "prettier \"src/**/!(static)/**/*.*(js|jsx)\" --write",
9-
"release": "semantic-release",
9+
"release": "semantic-release --allow-same-version",
1010
"release:debug": "semantic-release --debug",
1111
"release:dry-run": "semantic-release --dry-run",
1212
"test": "jest",

0 commit comments

Comments
 (0)