Updated README and CONTRIBUTING instructions #75
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ejboucher
approved these changes
Jul 23, 2024
ejboucher
approved these changes
Jul 23, 2024
juaneslucero
approved these changes
Jul 23, 2024
jonayuan
reviewed
Jul 23, 2024
| git clone https://github.com/<YOUR_GITHUB_USERNAME>/amazon-location-migration-adapter | ||
| cd amazon-location-migration-adapter | ||
| git remote add upstream https://github.com/aws-geospatial/amazon-location-migration-adapter.git | ||
| git remote set-url --push upstream THESE_ARENT_THE_DROIDS_WERE_LOOKING_FOR |
There was a problem hiding this comment.
The clear instructions are super helpful
jonayuan
reviewed
Jul 23, 2024
|
|
||
| Each example has an `index.html` and a `google.html` page, of which the only difference between them is that the `index.html` imports our migration adapter. | ||
| The examples also have an `example.js` script that holds the client logic for the example. This client logic is shared between both `index` and `google` example pages | ||
| in order to showcase that the client logic can invoke the same `google.maps` APIs, but will be re-routed by the migration adapter for any APIs that the migration adapter supports. |
There was a problem hiding this comment.
Explanation very much needed for new users
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updated the documentation with instructions on how to use the adapter.
READMEon how to create the necessary map/places/routes resources and create an API key with access to themREADMEfor how to import the adapter based on which Google Maps import method is being usedCONTRIBUTINGfile