Create README.md

README.md

@@ -0,0 +1,55 @@
+# Rome2RioAndroid
+A wrapper for the [Rome2Rio](https://www.rome2rio.com/) API. See the Rome2Rio [documentation](https://www.rome2rio.com/documentation/1-4/search/) for more information
+
+
+## Download
+TBD
+
+## Usage
+
+This library makes use of RxAndroid for its calls.
+
+        String key = {YOUR API KEY}
+        Rome2RioService service = new Rome2RioApiClient(this, key).getService();
+
+        SearchRequest searchRequest = new SearchRequest.SearchRequestBuilder()
+                .oName("Delft")
+                .dName("London")
+                .noBus()
+                .noCar()
+                .build();
+
+        service.getSearchResponseRx(searchRequest.toUrl())
+                .subscribeOn(Schedulers.newThread())
+                .observeOn(AndroidSchedulers.mainThread())
+                .subscribe(new SingleObserver<SearchResponse>() {
+                    @Override
+                    public void onSubscribe(Disposable d) {
+
+                    }
+
+                    @Override
+                    public void onSuccess(SearchResponse searchResponse) {
+                        textView.setText(searchResponse.toString());
+                    }
+
+                    @Override
+                    public void onError(Throwable e) {
+                        Log.d(TAG, "onError() called with: e = [" + e + "]");
+                    }
+                });
+
+
+## License
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.