diff --git a/README.md b/README.md index 9b8786f..cfe18e1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,37 @@ -# TODO -standalone view maybe \ No newline at end of file +# Map+ + +A performant and customizable map layout for Obsidian Bases. This plugin functions similarly to [the official Maps plugin](https://github.com/obsidianmd/obsidian-maps), but is more performant for big vaults, adds extensibility with a tag hierarchy, adds thumbnail support to locations, and allows more customizability in general. + +![Preview](images/preview.png) +![Settings](images/settings.png) + +## Usage + +### Setting up coordinates + +**Option 1: Use global frontmatter keys** + +In plugin settings, set: +- Latitude key (e.g., `lat` or `location[0]`) +- Longitude key (e.g., `lng` or `location[1]`) + +These will be used as the global default. + +**Option 2: Use a coordinates property in your base** + +In your base view options, set the "Coordinates property" to a property containing coordinates. + +The property value should be either: +- A list: `[latitude, longitude]` +- A string: `"latitude,longitude"` + +### Customizing tags + +In plugin settings under "Tags": + +1. Click "Add" to create a tag customization +2. Choose a tag from your vault +3. Pick a color and optional icon +4. Drag tags to reorder priority + +Higher tags take precedence in locations with multiple tags. diff --git a/images/preview.png b/images/preview.png new file mode 100644 index 0000000..950f4be Binary files /dev/null and b/images/preview.png differ diff --git a/images/settings.png b/images/settings.png new file mode 100644 index 0000000..2b66fa5 Binary files /dev/null and b/images/settings.png differ diff --git a/manifest.json b/manifest.json index 74931e3..810d1c9 100644 --- a/manifest.json +++ b/manifest.json @@ -1,6 +1,6 @@ { - "id": "map", - "name": "Map", + "id": "mapplus", + "name": "Map+", "version": "1.0.0", "minAppVersion": "0.15.0", "description": "A performant and customizable map inside Bases",