@fuzo/soccer-board 0.1.0-alpha.2 → 0.2.0-alpha.2

package/README.md

@@ -22,7 +22,7 @@ A beautiful, interactive soccer field component for Angular applications. Create
 ## 📦 Installation
 
 ```bash
-npm install fuzo-soccer-board
+npm install @fuzo/soccer-board
 ```
 
 That's it! The library includes `html2canvas-pro` as a dependency for PNG export functionality (supports modern CSS color functions like `oklab`).
@@ -32,7 +32,7 @@ That's it! The library includes `html2canvas-pro` as a dependency for PNG export
 ### 1. Import the Component
 
 ```typescript
-import { SoccerBoardComponent, SoccerBoardPlayer, SoccerBoardOrientation, SoccerBoardTeamSide } from 'fuzo-soccer-board';
+import { SoccerBoardComponent, SoccerBoardPlayer, SoccerBoardOrientation, SoccerBoardTeamSide } from '@fuzo/soccer-board';
 
 @Component({
   selector: 'app-my-component',
@@ -316,6 +316,26 @@ Make sure player photos are accessible and CORS is configured correctly if loadi
 - Use `[fit]="SoccerBoardFitMode.Contain"` for responsive behavior
 - Ensure parent container has defined dimensions
 
+## 💻 Local Development
+
+If you want to use the library locally in your project during development (to test changes before publishing), you can use the `file:` protocol in your `package.json`:
+
+```bash
+# In your project's package.json, add:
+{
+  "dependencies": {
+    "@fuzo/soccer-board": "file:/absolute/path/to/soccer-board-workspace/dist/soccer-board-angular"
+  }
+}
+
+# Then install:
+npm install
+```
+
+**Note:** After making changes to the library, rebuild it (`npm run build` in the library directory) and reinstall in your project (`npm install`) to see the changes.
+
+For more advanced local development options (including npm link), see the source repository's documentation.
+
 ## 🤝 Contributing
 
 Contributions are welcome! Please feel free to submit a Pull Request.