Skip to content
This repository was archived by the owner on Dec 29, 2019. It is now read-only.

Commit d42b63e

Browse files
committed
Merge branch 'master' of https://github.com/markrjr/Salut
2 parents e6d22b4 + 46a4070 commit d42b63e

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,11 @@ Next, start by implementing the `SalutDataCallback` in the class that you would
5555
Then, we need to create a `SalutDataReceiver` and a `SalutServiceData` object.
5656
```
5757
SalutDataReceiver dataReceiver = new SalutDataReceiver(myActivity, myActivity);
58-
SalutServiceData serviceData = new SalutServiceData("superawesomeservice", 50489, superAwesomeUser.name);
58+
SalutServiceData serviceData = new SalutServiceData("sas", 50489, superAwesomeUser.name);
5959
```
6060
`SalutDataReceiver` takes two arguments,`(Activity activity, SalutDataCallback dataCallback)`. In the example above, our activity implements `SalutDataCallback`, so we pass it in twice. Passing in an activity in general allows Salut to automatically register and unregister the neccessary broadcast receivers for you app.
6161

62-
`SalutServiceData` takes in a service name (which should be lowercase and start with an underscore), a port, and an instance name. The instance name is basically a readable name that will be shown to users. So it's a good idea to make this something not cryptic.
62+
`SalutServiceData` takes in a service name (which should be lowercase), a port, and an instance name. The instance name is basically a readable name that will be shown to users. So it's a good idea to make this something not cryptic. **Use relatively small strings for both the service name and readable names if you plan to support lower than Android 5.0, as there is a limitation on the size that those values can be. This is imposed by the system itself.**
6363

6464
Finally, create a `Salut` instance.
6565

0 commit comments

Comments
 (0)