Skip to content

Commit 0e1afde

Browse files
committed
Update README
- Add new method descriptions - Add contributors to credit section
1 parent 88e6e81 commit 0e1afde

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,25 @@ Use the what3words API in your Java applications.
99
double[] wordsToPosition(String[] words)
1010
```
1111

12-
Converts a 3 words 'address' into a position
12+
Converts a 3 words 'address' into a position (assumes words in the default language 'en')
13+
14+
```java
15+
double[] wordsToPosition(String[] words, String language)
16+
```
17+
18+
Converts a 3 words 'address' (in the given language) into a position
1319

1420
```java
1521
String[] positionToWords(double[] coords)
1622
```
1723

18-
Converts a position into a 3 words 'address'
24+
Converts a position into a 3 words 'address' (language 'en')
25+
26+
```java
27+
String[] positionToWords(double[] coords, String language)
28+
```
29+
30+
Converts a position into a 3 words 'address' (in the given language)
1931

2032
## Code Samples
2133

@@ -37,8 +49,7 @@ What3Words w3w = new What3Words(apiKey);
3749
Double[] coords = {49.422636, 8.320833};
3850
try {
3951
// optionally set a different language
40-
w3w.setLanguage("de");
41-
String[] words = w3w.positionToWords(coords);
52+
String[] words = w3w.positionToWords(coords, "de");
4253
System.out.println(words[0] + "." + words[1] + "." + words[2]);
4354
} catch (Exception e) {
4455
// do your error handling
@@ -66,6 +77,11 @@ Any contribution is warmly welcome:
6677
Thanks to [what3words ](http://what3words.com/) for offering such a great
6778
project and for any help we received by their team.
6879

80+
Also a big thank you to all who contributed to this project:
81+
* [@chrismayer](https://github.com/chrismayer)
82+
* [@tsamaya](https://github.com/tsamaya)
83+
* [@jstastny](https://github.com/jstastny)
84+
6985

7086
## Who do I talk to?
7187
You need more information or support? Please contact us at

0 commit comments

Comments
 (0)