@arantic/bugpin-widget 0.1.2 → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Arantic Digital
+
+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

@@ -26,21 +26,20 @@ import BugPin from '@arantic/bugpin-widget';
 
 BugPin.init({
   apiKey: 'your-project-api-key',
-  serverUrl: 'https://your-bugpin-server.com'
+  serverUrl: 'https://your-bugpin-server.com',
 });
 ```
 
 ## Configuration
 
-The widget automatically fetches its configuration from the BugPin server based on your API key. All visual settings (theme, position, colors, button text) are managed in the BugPin admin UI.
+The widget automatically fetches its configuration from the BugPin server based on your API key. All visual settings (theme, position, colors, button text) are managed in the BugPin admin portal.
 
 ### Required Options
 
-| Option | Type | Description |
-|--------|------|-------------|
-| `apiKey` | `string` | Your project API key (from BugPin admin) |
-| `serverUrl` | `string` | Your BugPin server URL |
-
+| Option      | Type     | Description                              |
+| ----------- | -------- | ---------------------------------------- |
+| `apiKey`    | `string` | Your project API key (from BugPin admin) |
+| `serverUrl` | `string` | Your BugPin server URL                   |
 
 ## Framework Examples
 
@@ -54,7 +53,7 @@ function App() {
   useEffect(() => {
     BugPin.init({
       apiKey: import.meta.env.VITE_BUGPIN_API_KEY,
-      serverUrl: import.meta.env.VITE_BUGPIN_SERVER_URL
+      serverUrl: import.meta.env.VITE_BUGPIN_SERVER_URL,
     });
   }, []);
 
@@ -72,7 +71,7 @@ function App() {
   useEffect(() => {
     BugPin.init({
       apiKey: process.env.NEXT_PUBLIC_BUGPIN_API_KEY,
-      serverUrl: process.env.NEXT_PUBLIC_BUGPIN_SERVER_URL
+      serverUrl: process.env.NEXT_PUBLIC_BUGPIN_SERVER_URL,
     });
   }, []);
 
@@ -90,7 +89,7 @@ import BugPin from '@arantic/bugpin-widget';
 onMounted(() => {
   BugPin.init({
     apiKey: import.meta.env.VITE_BUGPIN_API_KEY,
-    serverUrl: import.meta.env.VITE_BUGPIN_SERVER_URL
+    serverUrl: import.meta.env.VITE_BUGPIN_SERVER_URL,
   });
 });
 </script>
@@ -105,13 +104,13 @@ import BugPin from '@arantic/bugpin-widget';
 
 @Component({
   selector: 'app-root',
-  templateUrl: './app.component.html'
+  templateUrl: './app.component.html',
 })
 export class AppComponent implements OnInit {
   ngOnInit() {
     BugPin.init({
       apiKey: environment.bugpinApiKey,
-      serverUrl: environment.bugpinServerUrl
+      serverUrl: environment.bugpinServerUrl,
     });
   }
 }
@@ -126,7 +125,7 @@ import BugPin from '@arantic/bugpin-widget';
 document.addEventListener('DOMContentLoaded', () => {
   BugPin.init({
     apiKey: 'your-api-key',
-    serverUrl: 'https://bugpin.example.com'
+    serverUrl: 'https://bugpin.example.com',
   });
 });
 ```
@@ -188,7 +187,7 @@ NEXT_PUBLIC_BUGPIN_SERVER_URL=https://bugpin.example.com
 # .NET (appsettings.json)
 {
   "BugPin": {
-    "ApiKey": "your-api-key",
+    "ApiKey": "your-project-api-key",
     "ServerUrl": "https://bugpin.example.com"
   }
 }
@@ -196,10 +195,12 @@ NEXT_PUBLIC_BUGPIN_SERVER_URL=https://bugpin.example.com
 
 ## Getting Your API Key
 
-1. Deploy BugPin server (self-hosted or use the official Docker image)
-2. Log in to the BugPin admin panel
-3. Create a new project or select an existing one
-4. Copy the API key from the project settings
+You need an API key from your BugPin server to initialize the widget.
+
+1. Deploy BugPin server on your infrastructure (e.g. using [Docker](https://docs.bugpin.io/installation/docker))
+2. Log in to the BugPin admin portal
+3. Open **Projects**, create a new project or select an existing one
+4. Copy the API key (shown in the project card or in **Project Settings**)
 
 ## Documentation