Skip to content

Commit

Permalink
Better readme (#36)
Browse files Browse the repository at this point in the history
* improved documentation

* something about livewire
  • Loading branch information
LarsWiegers authored Oct 2, 2022
1 parent b5d75c0 commit bad7ba0
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,12 +89,21 @@ You can get an api key here:
![console.cloud.google.com](https://console.cloud.google.com/project/_/apiui/credential)
Create an api key and enable the Maps Javascript API in the console aswell.
Place the api key in the env file like this ``MAPS_GOOGLE_MAPS_ACCESS_TOKEN``

### Usage in livewire
This library does not support livewire out of the box, but some users have found a workaround to work.
Please see this issue for more information: https://github.com/LarsWiegers/laravel-maps/issues/34

Feel free to PR a livewire component if you have the time.
### Testing
To run the tests just use the following component:
```bash
composer test
```

Testing is done through rendering the blade components and making assertions on the html outputted.
While this is great for initial testing it does lack some more certainty. In the future an browser test may be needed to further make sure that the code works as intended.

### Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
Expand Down

0 comments on commit bad7ba0

Please sign in to comment.