Skip to content

Commit f05ad69

Browse files
authored
Update README.md
1 parent cd17c82 commit f05ad69

1 file changed

Lines changed: 14 additions & 4 deletions

File tree

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
This is a library which helps you to get LIVE notifications of actions taking place on your webistes and applications.
44
Just Copy past the below codes and get live updates of errors and actions. Make Categories of pings based on projects (etc) and assign it to your team mates.
5-
That's what PING ME LIVE does.
5+
That's what PingMeLive does.
66
Easy right!.
77

88
## How to use
99

1010
### Register yourself on
11-
[https://pingmelive.com](https://pingmelive.com)
12-
You will get your API KEY after registeration.
11+
12+
[https://pingmelive.com](https://pingmelive.com) **and get your `API KEY`**.
1313

1414
### One-step install
1515

@@ -101,6 +101,17 @@ Button registerUser = findViewById(R.id.registerUser);
101101

102102
```
103103

104+
105+
### Options
106+
* **apiKey** : To get an `API KEY` , register on pingmelive.com. Its free to use.
107+
* **projectID** : Once registered, Click on New Project to create.
108+
* **errorStatus** : `true` / `false` (Boolen Value).
109+
* **errorName** : This will be your `Group Title/Name` where all the error will be pinged.(This works when `errorStatus` is set as `true`.
110+
* **groupTitle** : This will be your `Group Tilte/Name` under which , you will get all your pings.
111+
* **eventMessage** : The `errorMessage` is limited to 360 character in length. Any additional characters beyond 360 character will be truncated.
112+
* **detailDescription** : The `detailDescription` is does not have any length limitation. You can also send JSON Formatted String / or simple plain string.
113+
114+
104115
## Some usefull information
105116

106117
* Only `Detailed event` will by default contain the information like device info,app version code etc.
@@ -124,5 +135,4 @@ When an exception is caught by the library's `UncaughtExceptionHandler` it does
124135

125136
* This will not avoid ANRs from happening.
126137
* This will not catch native errors.
127-
* There is no guarantee that this will work on every device.
128138
* This library will not make you toast for breakfast :)

0 commit comments

Comments
 (0)