diff --git a/README.md b/README.md index 2c161056..ea50e317 100644 --- a/README.md +++ b/README.md @@ -15,30 +15,40 @@ Map UI is a JavaScript Map Library to create nice and easy to use Maps ### Getting Started + install via npm ``` npm install utopia-ui ``` -import in your React App - +then import in your React App ``` -import Map from 'utopia-ui' +import UtopiaMap from 'utopia-ui' ``` -use the Map UI Component - +use the [Map UI Component](/docs/utopia-ui/map-components/map) ``` - + + height='360px' + width='100vw' + center={[51.3, 9.6]} + zoom={6} + places={places} + events={events} + ``` ### Options - Option | Type | Default | Description - --- | --- | --- | --- - height | string | - | height of the map - width | string | - | width of the map + Option | Type | Default | Required | Description + --- | --- | --- | --- | --- + `height` | `string` | - | | height of the map + `width` | `string` | - | | width of the map + `center` | `LatLngExpression`| - | | initial map position + `zoom` | `number` | - | | initial zoom level + `places` | [`Item[]`](https://utopia-os.org/docs/utopia-ui/map-components/item)| - | | Array with Items + `events` | [`Item[]`](https://utopia-os.org/docs/utopia-ui/map-components/item) | - | | Array with Items ## Coming Soon diff --git a/package.json b/package.json index 50dfdd12..4eed0761 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "utopia-ui", - "version": "1.0.4", + "version": "1.0.5", "description": "Reuseable React Components to build mapping apps for all kinds of communities ", "repository": "https://github.com/utopia-os/utopia-ui", "homepage:": "https://utopia.os/",