Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
utsmannn committed Apr 24, 2023
1 parent b2f5939 commit dd5bae2
Showing 1 changed file with 20 additions and 156 deletions.
176 changes: 20 additions & 156 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,165 +1,29 @@
# OpenStreetMap Android Compose

[//]: # (## Load Map)
For install and usage, please check [documentation](https://utsmannn.github.io/osm-android-compose/)

[//]: # (```kotlin)
# Welcome

[//]: # (OpenStreetMap()
The origin OpenStreetMaps Android visit [https://osmdroid.github.io/osmdroid/](https://osmdroid.github.io/osmdroid/) or [github wiki](https://github.com/osmdroid/osmdroid/wiki)

[//]: # ( modifier = Modifier.fillMaxSize(),)
This is a simple OpenStreetMap library for Android Compose. There are several basic functions commonly used, such as markers, polylines, and polygons. You can also add custom tiles. For more details, please refer to the sample project.

[//]: # ( cameraState = cameraState,)
## Contributing
This library may not always be maintained, and I am open to anyone who wants to contribute by reporting bugs, making pull requests, or requesting new features in the future.

[//]: # ( overlayManagerState = overlayManagerState,)
## License
```
Copyright 2023 Muhammad Utsman
[//]: # ( properties = mapProperties,)
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
[//]: # ( onMapClick = {)

[//]: # ( println("on click -> $it"))

[//]: # ( },)

[//]: # ( onMapLongClick = {)

[//]: # ( depokState.geoPoint = it)

[//]: # ( println("on long click -> ${it.latitude}, ${it.longitude}"))

[//]: # ()
[//]: # ( },)

[//]: # ( onFirstLoadListener = {)

[//]: # ( println("on loaded ... "))

[//]: # ( })

[//]: # ())

[//]: # (```)

[//]: # ()
[//]: # (## Marker)

[//]: # (```kotlin)

[//]: # (OpenStreetMap()

[//]: # ( modifier = Modifier.fillMaxSize(),)

[//]: # ( cameraState = cameraState)

[//]: # () {)

[//]: # ( Marker()

[//]: # ( state = depokState,)

[//]: # ( icon = depokIcon,)

[//]: # ( title = "Depok",)

[//]: # ( snippet = "Kota Depok")

[//]: # ( ) {)

[//]: # ( // info window (optional))

[//]: # ( Column()

[//]: # ( modifier = Modifier)

[//]: # ( .size(100.dp))

[//]: # ( .background(color = Color.Gray, shape = RoundedCornerShape(12.dp)))

[//]: # ( ) {)

[//]: # ( Text(text = it.title))

[//]: # ( Text(text = it.snippet))

[//]: # ( })

[//]: # ( })

[//]: # (})

[//]: # (```)

[//]: # ()
[//]: # (### Polyline)

[//]: # (```kotlin)

[//]: # (OpenStreetMap()

[//]: # ( modifier = Modifier.fillMaxSize(),)

[//]: # ( cameraState = cameraState)

[//]: # () {)

[//]: # ( Polyline()

[//]: # ( geoPoints = points,)

[//]: # ( color = Color.Cyan,)

[//]: # ( cap = PolylineCap.ROUND)

[//]: # ( ) {)

[//]: # ( // info window (optional))

[//]: # ( Column()

[//]: # ( modifier = Modifier)

[//]: # ( .size(100.dp))

[//]: # ( .background(color = Color.Red, shape = RoundedCornerShape(6.dp)))

[//]: # ( ) {)

[//]: # ( Text(text = it.title))

[//]: # ( Text(text = it.snippet))

[//]: # ( })

[//]: # ( })

[//]: # (})

[//]: # (```)

[//]: # ()
[//]: # (### Polygon)

[//]: # (```kotlin)

[//]: # (OpenStreetMap()

[//]: # ( modifier = Modifier.fillMaxSize(),)

[//]: # ( cameraState = cameraState)

[//]: # () {)

[//]: # ( Polygon()

[//]: # ( geoPoints = points,)

[//]: # ( color = Color.Blue,)

[//]: # ( outlineColor = Color.Green)

[//]: # ( ))

[//]: # (})

[//]: # (```)

### Under deployment
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.
```

0 comments on commit dd5bae2

Please sign in to comment.