Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
theAlexPatin committed Apr 8, 2022
1 parent e047563 commit e4aa93b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The JavaScript sdk for integrating AvatarConnect into your web-based metaverse
Via CDN:

```html
<script src="https://cdn.jsdelivr.net/npm/@avatarconnect/sdk@0.0.1/dist/browser.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@avatarconnect/sdk@0.0.1/dist/index.js"></script>
```

Using npm:
Expand Down Expand Up @@ -56,7 +56,7 @@ new AvatarConnect(<providers>[, <options>])

### Providers

TODO: Add documentation about providers here
Check out our docs for more info on provider configurations

### Options

Expand Down
7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
"version": "0.0.1",
"description": "One toolkit to integrate every avatar project",
"private": false,
"main": "dist/index.js",
"module": "dist/index.js",
"browser": "dist/index.js",
"types": "dist/index.d.ts",
"keywords": [
"AvatarConnect",
"avatars",
Expand Down Expand Up @@ -36,15 +40,12 @@
"url": "https://github.com/AvatarConnect/sdk/issues"
},
"homepage": "https://github.com/AvatarConnect/sdk",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"scripts": {
"clean": "./node_modules/.bin/rimraf dist workers",
"build": "yarn clean && webpack",
"lint": "./node_modules/.bin/eslint --fix .",
"pub": "yarn lint && yarn build && yarn publish"
},
"dependencies": {},
"devDependencies": {
"@types/node": "^17.0.22",
"@typescript-eslint/eslint-plugin": "^5.16.0",
Expand Down

0 comments on commit e4aa93b

Please sign in to comment.