unite-lib 1.0.0 → 1.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 unite-lib contributors
+
+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

@@ -8,67 +8,6 @@ Assets and data library for **Pokémon Unite**: roster, names, images, moves, an
 npm install unite-lib
 ```
 
-## Testing locally (consumir no seu projeto sem publicar no npm)
-
-Para testar a library em outro projeto na sua máquina sem publicar no npm:
-
-### 1. Buildar a library
-
-Na pasta da **unite-lib**:
-
-```bash
-cd unite-lib
-npm run build
-```
-
-### 2. Usar no seu projeto
-
-**Opção A — `npm link` (symlink, ótimo para desenvolvimento)**
-
-Na pasta da library:
-
-```bash
-npm link
-```
-
-No seu outro projeto (ex.: app que consome a library):
-
-```bash
-cd /caminho/do/seu/projeto
-npm link unite-lib
-```
-
-A partir daí, `import { pokemons, getPokemonName } from "unite-lib"` usa a versão local. Ao alterar a library, rode `npm run build` nela de novo; o projeto que a consome já aponta para o mesmo pacote.
-
-Para desfazer no projeto consumidor: `npm unlink unite-lib`.
-
-**Opção B — dependência `file:` (cópia/instalação a partir do caminho)**
-
-No `package.json` do seu projeto, adicione:
-
-```json
-{
-  "dependencies": {
-"unite-lib": "file:../unite-lib"
-}
-}
-```
-
-Ajuste `../unite-lib` para o caminho relativo (ou absoluto) até a pasta da library. Depois:
-
-```bash
-npm install
-```
-
-Sempre que mudar a library, rode `npm run build` nela e, se quiser atualizar a cópia no consumidor, `npm install` de novo no projeto (ou use `npm update unite-lib`).
-
-### Imagens ao testar localmente
-
-Os caminhos de imagem são relativos (ex.: `pokemons/roster-venusaur.png`). No consumidor você pode:
-
-- Usar **baseUrl** ao chamar `getImageUrl(pokemon, "main", { baseUrl: "http://localhost:3000/node_modules/unite-lib" })` se o bundler/servidor servir `node_modules`, ou
-- Apontar **baseUrl** para onde as pastas `pokemons/`, `moves/`, `maps/` estejam acessíveis no seu app.
-
 ## Usage
 
 ### Data and helpers
@@ -121,6 +60,99 @@ getPokemonName("venusaur", "es");    // "Venusaur"
 
 Supported locales: `en`, `pt-BR`, `ja-JP`, `fr`, `es`.
 
+## Content
+
+The library includes data and images ready to use in Pokémon Unite apps, bots, and sites.
+
+### Roster (Pokémon)
+
+Roster icons and stat images for the full active roster.
+
+| Roster example | Stats example |
+|----------------|----------------|
+| ![Pikachu](pokemons/roster-pikachu.png) | ![Pikachu stats](pokemons/stat-pikachu.png) |
+| ![Charizard](pokemons/roster-charizard.png) | ![Charizard stats](pokemons/stat-charizard.png) |
+| ![Venusaur](pokemons/roster-venusaur.png) | ![Venusaur stats](pokemons/stat-venusaur.png) |
+
+### Moves
+
+Move images (slot 1 and 2, variants 1 and 2) per Pokémon.
+
+| Slot 1.1 | Slot 1.2 | Slot 2.1 | Slot 2.2 |
+|----------|----------|----------|----------|
+| ![Pikachu S11](moves/pikachu_s11.png) | ![Pikachu S12](moves/pikachu_s12.png) | ![Pikachu S21](moves/pikachu_s21.png) | ![Pikachu S22](moves/pikachu_s22.png) |
+
+### Maps
+
+Game map images (Remoat Stadium, Theia Sky Ruins, Mer Stadium, etc.).
+
+![Map](maps/groudon.png)
+
+---
+
+## Local development (testing without publishing to npm)
+
+To test the library in another project on your machine without publishing to npm:
+
+### 1. Build the library
+
+From the **unite-lib** folder:
+
+```bash
+cd unite-lib
+npm run build
+```
+
+### 2. Use in your project
+
+**Option A — `npm link` (symlink, great for development)**
+
+From the library folder:
+
+```bash
+npm link
+```
+
+In your other project (e.g. the app that consumes the library):
+
+```bash
+cd /path/to/your/project
+npm link unite-lib
+```
+
+From then on, `import { pokemons, getPokemonName } from "unite-lib"` uses the local version. When you change the library, run `npm run build` again; the consuming project already points to the same package.
+
+To undo in the consuming project: `npm unlink unite-lib`.
+
+**Option B — `file:` dependency (install from path)**
+
+In your project's `package.json`, add:
+
+```json
+{
+  "dependencies": {
+    "unite-lib": "file:../unite-lib"
+  }
+}
+```
+
+Adjust `../unite-lib` to the relative (or absolute) path to the library folder. Then:
+
+```bash
+npm install
+```
+
+Whenever you change the library, run `npm run build` in it and, to refresh the copy in the consumer, run `npm install` again in the project (or use `npm update unite-lib`).
+
+### Images when testing locally
+
+Image paths are relative (e.g. `pokemons/roster-venusaur.png`). In the consumer you can:
+
+- Use **baseUrl** when calling `getImageUrl(pokemon, "main", { baseUrl: "http://localhost:3000/node_modules/unite-lib" })` if the bundler/server serves `node_modules`, or
+- Point **baseUrl** to where the `pokemons/`, `moves/`, and `maps/` folders are available in your app.
+
+---
+
 ## CDN (browser)
 
 ```html
@@ -130,7 +162,7 @@ Supported locales: `en`, `pt-BR`, `ja-JP`, `fr`, `es`.
 </script>
 ```
 
-Asset URLs via jsDelivr (replace `@latest` with a version if needed):
+Asset URLs via jsDelivr (substitua `@latest` por uma versão se quiser):
 
 - `https://cdn.jsdelivr.net/npm/unite-lib@latest/pokemons/roster-venusaur.png`
 - `https://cdn.jsdelivr.net/npm/unite-lib@latest/moves/venusaur_s11.png`
@@ -159,6 +191,8 @@ Asset URLs via jsDelivr (replace `@latest` with a version if needed):
 - **`pokemons/`** — Roster and stat images
 - **`moves/`** — Move images
 - **`maps/`** — Map images
+- **`.cursor/skills/`** — [Cursor Agent Skills](https://docs.cursor.com/context/agent-skills) for use with AI agents in this repo (e.g. syncing roster from images in `pokemons/` and `moves/`).
+- **`mcp/`** — [MCP server](mcp/README.md) (Model Context Protocol) para consumir a library em agentes de IA: tools para listar e buscar pokémons, moves, mapas, URLs de imagens e nomes localizados (Cursor, Claude Desktop, etc.).
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unite-lib",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Assets and data library for Pokémon Unite — names, images, moves, maps. Use via npm or CDN.",
   "type": "module",
   "main": "./dist/index.cjs",