Skip to content

Commit

Permalink
chore: change readme, bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
hansemannn committed Jul 12, 2022
1 parent 9635f31 commit f6bf762
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 24 deletions.
32 changes: 9 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Crashlytics in Appcelerator Titanium
# Crashlytics in Titanium

Use the native Fabric Crashlytics iOS / Android SDK in Appcelerator Titanium.
Use the native Crashlytics iOS / Android SDK in Titanium.

## Supporting this effort

Expand All @@ -10,20 +10,15 @@ thank you!

## Requirements

- [x] iOS: Titanium SDK 8.0.0+
- [x] Android: Titanium SDK 7.0.0+
- [x] iOS: Titanium SDK 9.2.0+
- [x] Android: Titanium SDK 9.0.0+

## Setup

In general, remember to not use any Crashlytics API's before actually opening your first window. While this might not result
in a crash on iOS, the native Android SDK will error if being used before your app finished launching due to requiring the
native `Activity`.

## Breaking changes!

Module version 2.0.0 uses Firebase Crashlytics instead of the (deprecated) Fabric Crashlytics. Please make sure to check the
removed and changed API's!

### iOS

1. Create a new folder `scripts/` in your project root
Expand Down Expand Up @@ -79,37 +74,28 @@ the required API keys and project settings.

### Cross platform API's

### `log(message)`
### `Crashlytics.log(message)`

Log a Custom Event to see user actions that are uniquely important for your app in real-time.

### `setUserIdentifier(userIdentifier)`
### `Crashlytics.userId = myUserId`

Specify a user identifier which will be visible in the Crashlytics UI.

### `recordError({ domain, code, userInfo })`
### `Crashlytics.recordError({ domain, code, userInfo })`

Records non-fatal errors. Note: The `code` and `userInfo` parameters are iOS-only.

### Android only API's

### `crash()`
### `Crashlytics.crash()`

Simulate a crash (for testing purpose)

### `throwException()`
### `Crashlytics.throwException()`

Simulate an exception (for testing purpose)

### `setUserName(userName)`

Specify a user name which will be visible in the Crashlytics UI.

### `setUserEmail(userEmail)`

Specify a user email which will be visible in the Crashlytics UI.


## Author

Hans Knöchel ([@hansemannnn](https://twitter.com/hansemannnn) / [Web](https://hans-knoechel.de))
Expand Down
2 changes: 1 addition & 1 deletion ios/manifest
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# this is your module manifest and used by Titanium
# during compilation, packaging, distribution, etc.
#
version: 4.4.0
version: 4.5.0
apiversion: 2
architectures: arm64 x86_64
description: titanium-crashlytics
Expand Down

0 comments on commit f6bf762

Please sign in to comment.