Skip to content

Commit f484715

Browse files
authored
Revise README for clarity and usage instructions
Updated README to remove configuration section and improve usage instructions.
1 parent 357e8c8 commit f484715

File tree

1 file changed

+5
-16
lines changed

1 file changed

+5
-16
lines changed

README.md

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -40,18 +40,7 @@ For classic HTML projects, you can use the CDN:
4040
- Clone from GitHub: `[email protected]:opencagedata/leaflet-opencage-geocoding.git`
4141
- Download a [zip or tarball archive](https://github.com/opencagedata/leaflet-opencage-geocoding/tags)
4242

43-
## Configuration
44-
45-
The control uses two image files that it expects to find in a directory with
46-
a path relative to the control's CSS files as `../images`. If you've installed
47-
the control using Bower you'll find these in `bower_components/Leaflet.OpenCage.Geocoding/dist/images/`. If you've
48-
cloned the control's GitHub repository or downloaded and unpacked an archive
49-
from GitHub, you'll find these in `dist/images`.
50-
51-
Whichever installation method you've chosen, you'll need to move a copy of these
52-
two image files to a directory relative to the location of the control's CSS files.
53-
54-
## Usage
43+
## Usage
5544

5645
Load the plugin's CSS and JavaScript files:
5746

@@ -77,8 +66,8 @@ L.tileLayer('http://tile.osm.org/{z}/{x}/{y}.png', {
7766

7867
## Customizing
7968

80-
By default, when a geocoding result is found, the control will center the map on it and place a marker
81-
at its location. This can be customized by overwriting the control's markGeocode function, to perform
69+
By default, when a geocoding result is found, the control will centre the map on it and place a marker
70+
at its location. This can be customised by overwriting the control's markGeocode function to perform
8271
any action desired.
8372

8473
For example:
@@ -101,7 +90,7 @@ This will add a polygon representing the result's boundingbox when a result is s
10190

10291
## Options
10392

104-
You can overwrite the following options, for example to translate.
93+
You can overwrite the following options, for example, to translate.
10594

10695
```javascript
10796
var options = {
@@ -132,7 +121,7 @@ See `CONTRIBUTING.md` file.
132121

133122
## Dependencies
134123

135-
Leaflet version 0.7+
124+
Leaflet version 0.7+ to 1.9.x
136125

137126
## License
138127

0 commit comments

Comments
 (0)