pw-js-api 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Doomester
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,55 @@
+# PW-JS-Api
+
+[PixelWalker](https://pixelwalker.net) API implementation for Node.js, Bun and modern browsers.
+
+
+Some of the typings may be incomplete, please let me know on discord (doomester) if you need help or clarifications.
+
+## Install
+
+NPM:
+```bash
+npm i pw-js-api
+```
+
+PNPM:
+```bash
+pnpm i pw-js-api
+```
+
+Yarn:
+```bash
+yarn add pw-js-api
+```
+
+Bun:
+```bash
+bun i pw-js-api
+```
+
+## Install (Browser)
+
+You could use a CDN like jsdelivr or unpkg. You can put this in your HTML page:
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/pw-js-api@0.0.1/browser/pw.prod.js"></script>
+```
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/pw-js-api@0.0.1/browser/pw.dev.js"></script>
+```
+
+When you have these scripts in your HTML file, you will be able to use the global variable PW which contains PWGameClient, PWApiClient and Constants.
+
+<!-- ## Example
+[Example Bot Source Code](https://github.com/doomestee/PW-JS-Api/blob/main/examples/) -->
+
+## Why?
+
+The difference between this and preexisting libraries is that this project aims to be as minimal as possible, trying to be more direct. As such, there are no helpers that comes along with the package itself.
+
+This project also uses functions instead of events for messages. This may be replaced if this isn't 
+
+## License
+
+[MIT](/LICENSE) License.