Skip to content

Commit c54e1ee

Browse files
committed
add keywords to package and update readme
1 parent 1ca248c commit c54e1ee

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,8 @@
1-
# WorldQL Client
2-
> https://docs.worldql.com/
1+
# WorldQL Client [![Node.js CI](https://github.com/WorldQL/client-typescript/actions/workflows/ci.yml/badge.svg)](https://github.com/WorldQL/client-typescript/actions/workflows/ci.yml)
2+
> TypeScript Client for interacting with WorldQL over WebSockets
3+
4+
## Documentation and Examples
5+
You can view setup instructions and a collection of code snippets on the WorldQL [documentation site](https://docs.worldql.com/client-libraries/typescript), along with a more in-depth [guide on building a real-world example project](https://docs.worldql.com/example-projects/chat-room).
6+
7+
## Community
8+
Join our [Discord Server](https://discord.gg/tDZkXQPzEw) for news and updates surrounding WorldQL!

package.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"name": "@worldql/client",
33
"version": "0.0.6",
4+
"description": "TypeScript Client for interacting with WorldQL over WebSockets",
45
"type": "module",
56
"exports": {
67
".": {
@@ -16,6 +17,14 @@
1617
"engines": {
1718
"node": "^12.20.0 || ^14.13.1 || >=16.0.0"
1819
},
20+
"keywords": [
21+
"worldql",
22+
"typescript",
23+
"client",
24+
"websockets",
25+
"message broker",
26+
"spatial database"
27+
],
1928
"scripts": {
2029
"prepublishOnly": "yarn run test && yarn run build",
2130
"test": "yarn run check && yarn run lint",

0 commit comments

Comments
 (0)