entityseven/fivem-rpc
2
0
Fork 0
mirror of https://github.com/rilaxik/fivem-rpc.git synced 2026-09-28 01:29:13 +00:00
Code Issues Packages Releases Activity

docs: bump readme.md + metadata

Browse Source
This commit is contained in:
rilaxik
2026-09-28 02:05:40 +01:00
parent c4c9d02fd4
commit 40c322e4b7
6 changed files with 132 additions and 169 deletions
Download Patch File Download Diff File Expand all files Collapse all files
readme.md
+7 -3
View File
@@ -1,6 +1,6 @@
# FiveM RPC
is an all-in-one package with asynchronous RPC implementation for FiveM servers in JS/TS
Call FiveM server, client and NUI listeners like async functions: typed, with timeouts, no event ping-pong
## Motivation
@@ -31,6 +31,8 @@ yarn add -D @entityseven/fivem-rpc-shared-types
bun add -d @entityseven/fivem-rpc-shared-types
```
Upgrading from 0.1: [migration guide](migration.md)
## Quick start
Create exactly one instance per environment and import it from your own module, not from the library. The client needs one even if it only relays between server and webview.
@@ -70,11 +72,13 @@ All methods: [API reference](rpc/readme.md).
Issues and pull requests are very welcome
Releases are published with `bun publish`, which replaces the `workspace:^` dependency on shared-types with its version (`npm publish` would not)
## License
Licensed under Custom Attribution-NoDerivs Software License
Licensed under the [Custom Attribution-NoDerivs Software License](license.md)
## WIP
## Roadmap
- client observers to catch events between server and webview (subscribe-like behaviour)
- client observers to prevent events (middleware-like behaviour)