diff --git a/README.md b/README.md index e9e89d6..2a0113d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ ACF OpenStreetMap Field ======================= +This is the official github repository of the [ACF Dropzone](https://wordpress.org/plugins/acf-openstreetmap-field/) plugin. + +About +----- + Configurable OpenStreetMap or Leaflet Field in ACF. Requires ACF 5.7+ @@ -13,35 +18,41 @@ Features - Custom map markers [through WordPress filters](../../wiki/HTML-Marker-Icon) and JS Events. - Installation - ------------ - - ### Production (using Github Updater – recommended for Multisite) - - Install [Andy Fragen's GitHub Updater](https://github.com/afragen/github-updater) first. - - In WP Admin go to Settings / GitHub Updater / Install Plugin. Enter `mcguffin/acf-openstreetmap-field` as a Plugin-URI. +Installation +------------ - ### Development - - cd into your plugin directory - - $ `git clone git@github.com:mcguffin/acf-openstreetmap-field.git` - - $ `cd acf-openstreetmap-field` - - $ `npm install` - - $ `npm run dev` +#### In WP Admin +Just follow the [Automatic Plugin Installation](https://wordpress.org/support/article/managing-plugins/#automatic-plugin-installation) procedere. +#### WP-CLI +```shell +$ wp plugin install --activate acf-openstreetmap-field +``` -Developing ----------- -This plugin uses gulp. - -To get started `cd` in the plugin directory, -run `npm install` then `gulp` +### Development +```shell +git clone git@github.com:mcguffin/acf-openstreetmap-field.git +cd acf-dropzone +npm install +npm run dev +``` Usage ----- There is some developer centric documentation in the [wiki](../../wiki). +Development +----------- +npm scripts: + - `npm run dev`: Watch css and js soure dirs + - `npm run build`: build assets + - `npm run release [ patch | minor | major ]`: Publish new release + - `npm run i18n`: generate `.pot` file + - `npm run package:wporg`: create zip for plugin submission + - `npm run rollback`: remove last commit (local and remote – use with caution!) + Thanks ------ - This plugin wouldn't have been possible without these awesome people and Projects: - Jan Pieter Waagmeester ([Leaflet Providers](https://github.com/leaflet-extras/leaflet-providers)) diff --git a/TODO.md b/TODO.md index 064a0ba..7b7aac7 100644 --- a/TODO.md +++ b/TODO.md @@ -1,5 +1,5 @@ - ACF OpenStreetMap Field ToDo ============================ - - [ ] Bug: Flexible-Content: Add entry > Repeater: Add entry, select type > Weird Map (3x searchfield) + - [x] Bug: Flexible-Content: Add entry > Repeater: Add entry, select type > Weird Map (3x searchfield) + - [x] ACF Field group attached to post > Block Editor > Map init with 1x1 tile upperleft corner diff --git a/index.php b/index.php index c1920e0..141e43e 100644 --- a/index.php +++ b/index.php @@ -2,15 +2,12 @@ /* Plugin Name: ACF OpenStreetMap Field -Plugin URI: https://github.com/mcguffin/acf-openstreetmap-field +Plugin URI: https://wordpress.org/plugins/acf-openstreetmap-field Description: A configurable OpenStreetMap Field for ACF. Author: Jörn Lund Version: 0.1.14 Author URI: https://github.com/mcguffin License: GPL3 -Github Repository: mcguffin/acf-openstreetmap-field -GitHub Plugin URI: mcguffin/acf-openstreetmap-field -Release Asset: false Text Domain: acf-openstreetmap-field Domain Path: /languages/ */