Skip to content

Commit 4b5da2d

Browse files
committed
add Readme
1 parent 37b3d12 commit 4b5da2d

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

Readme.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# vrchat-location-parser
2+
3+
A Node.js package to parse VRChat location string
4+
5+
## Installation
6+
7+
```sh
8+
npm install vrchat-location-parser
9+
```
10+
11+
or with pnpm:
12+
13+
```sh
14+
pnpm add vrchat-location-parser
15+
```
16+
17+
## Usage
18+
19+
```ts
20+
import { parseInstance, parseLocation } from 'vrchat-location-parser'
21+
22+
parseLocation('wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd:12345~region(eu)')
23+
24+
parseInstance('wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd', '12345~region(eu)')
25+
26+
```
27+
28+
## Contributing
29+
Pull requests are welcome! If you have any ideas, feel free to open an issue.
30+

0 commit comments

Comments
 (0)