Skip to content

Commit 1822565

Browse files
committed
Add typedoc
1 parent 44b9c14 commit 1822565

File tree

3 files changed

+18
-5
lines changed

3 files changed

+18
-5
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
1-
# websocket
2-
a low level wrapper over discord's gateway and voice websocket
1+
# Detritus Client Socket
2+
![npm](https://img.shields.io/npm/v/detritus-client-socket?style=flat-square)
3+
4+
A pure-TypeScript low-level wrapper for just Discord's Gateway and Voice Connection.
5+
6+
- [API Documentation](https://socket.detritusjs.com)
7+
- [npm](https://www.npmjs.com/package/detritus-client-socket)
38

49
## usage
510
```js

package.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@
1212
"ws": "^7.3.1"
1313
},
1414
"devDependencies": {
15-
"@types/node": "^12.12.51"
15+
"@types/node": "^12.12.51",
16+
"typedoc": "^0.17.8",
17+
"typescript": "^3.9.7"
1618
},
1719
"peerDependencies": {
1820
"erlpack": "^0.1.3",
@@ -45,7 +47,8 @@
4547
"scripts": {
4648
"build": "tsc",
4749
"test": "echo \"Error: no test specified\" && exit 1",
48-
"prepare": "npm run build"
50+
"prepare": "npm run build",
51+
"typedoc": "typedoc ./src"
4952
},
5053
"repository": {
5154
"type": "git",

tsconfig.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,10 @@
88
"strict": true
99
},
1010
"include": ["src"],
11-
"exclude": ["node_modules"]
11+
"exclude": ["node_modules"],
12+
"typedocOptions": {
13+
"mode": "file",
14+
"name": "Detritus Socket Client",
15+
"out": "./docs"
16+
}
1217
}

0 commit comments

Comments
 (0)