Skip to content

Commit e50391a

Browse files
committed
readme for gradle and swiftpm
1 parent 1675c80 commit e50391a

1 file changed

Lines changed: 11 additions & 17 deletions

File tree

README.md

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,24 @@ This package requires Unity 2022.3.27 (LTS), Unity 6 or newer.
99
To use Bugfender in your Unity project, follow these steps:
1010
* Browse to the Package Manager panel (**Window** menu > **Package Manager**)
1111
* Press the **Add (+)** button and **Add package from git URL...**
12-
* Enter the URL: <code>https://github.com/bugfender/BugfenderSDK-Unity.git#2.0.0-alpha.0</code>
13-
* From the **Project** panel, drag the **Packages** / **Bugfender** / **Bugfender** prefab to your main scene.
12+
* Enter the URL: `https://github.com/bugfender/BugfenderSDK-Unity.git#2.0.0-alpha.0`
13+
* From the **Project** panel, open the **Packages** / **Bugfender** package and drag the **Bugfender** prefab to your main scene.
1414
* Set the app key in the **Inspector** panel.
15-
* You can use the <code>Bugfender.Log()</code> method to write logs.
15+
* You can use the `Bugfender.Log()` method to write logs.
1616

1717
If your game has several scenes, you only need to add Bugfender once, on the first scene that gets executed.
1818

19-
If you use Bugfender in a platform other than iOS or Android, any calls to Bugfender will be just ignored but other than that, your application will keep working as usual. Please note the WebGL platform is currently not supported yet, although we plan to support it in the future.
19+
If you use Bugfender in a platform other than iOS or Android, any calls to Bugfender will be ignored. Other than that, your application will keep working as usual. Please note the WebGL platform is not supported yet, although we plan to support it in the future.
2020

2121
### Script Execution Order
22-
You want the Bugfender SDK to initialize early to capture as many logs and errors as possible. Therefore, you can tweak the execution order to make sure it runs before other scripts. By default, it starts with priority <code>-1</code> (lowest runs first).
22+
You want the Bugfender SDK to initialize early to capture as many logs and errors as possible. Therefore, you can tweak the execution order to make sure it runs before other scripts. By default, it starts with priority `-1` (lowest runs first).
2323

24-
You can change the priority in the **Project Settings** > **Script Execution Order**:
24+
You can change the priority in the **Project Settings** > **Script Execution Order**.
2525

26-
![Script Execution Order](https://user-images.githubusercontent.com/864706/220148469-91455103-32d7-46fc-be27-c718f86dc930.png)
26+
### Adjust the native Bugfender SDK versions
27+
This package imports the native Bugfender SDKs for iOS and Android using Swift Package Manager and Gradle.
2728

28-
## How to update the libraries
29+
By default, the latest compatible versions are used. If you would like to tweak that, you can fork this project and edit these files:
2930

30-
To update the Android library:
31-
* Download the [Bugfender Android SDK aar file](https://central.sonatype.com/artifact/com.bugfender.sdk/android/versions) (click on **Browse**, then download the file)
32-
* Delete the current file in `Plugins/Android` and replace it with the .aar file just downloaded
33-
34-
To update the iOS framework:
35-
* Download the latest [Bugfender iOS SDK release](https://github.com/bugfender/BugfenderSDK-iOS/releases): `BugfenderSDK.xcframework.zip`
36-
* Unzip it
37-
* Under `Plugins/iOS`, delete the current `BugfenderSDK.xcframework` and replace it with the one you just downloaded (keep `BugfenderBridge.mm`)
38-
* Edit the `BugfenderSDK.xcframework` item and, under the **iOS Platform settings**, add the following **Framework Dependencies**: `MobileCoreServices` and `Security`; and check **Add to Embedded Binaries**.
31+
* For iOS: `Editor/IOSProjectBuildCustomizer.cs`
32+
* For Android: `Runtime/Plugins/Android/Bugfender.androidlib/build.gradle`

0 commit comments

Comments
 (0)