Skip to content

Commit

Permalink
Merge pull request #229 from ryanttb/master
Browse files Browse the repository at this point in the history
jQuery 3 support and point buffer function
  • Loading branch information
ryanttb authored Oct 6, 2018
2 parents f9e10f8 + 67d4ada commit a01afea
Show file tree
Hide file tree
Showing 12 changed files with 2,672 additions and 333 deletions.
20 changes: 16 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,18 @@ Regarding code style like indentation and whitespace, **follow the conventions y

Please follow jQuery Foundation [JavaScript Style Guide](http://contribute.jquery.org/style-guide/js/) and/or [idomatic.js](https://github.com/rwldrn/idiomatic.js/).

## Working with the source code

The source code is in the `js` subdirectory. There is an empty HTML page in the test subdirectory which is pulling in the individual files from the `js` subdirectory in the correct order.

To quickly get up an running and view the test page in a web browser, you can use the [local-web-server](https://www.npmjs.com/package/local-web-server) package.

```
npm install -g local-web-server
```

Then change to the geo directory and run `ws`. You should now be able to view the test page by going to: http://localhost:8000/test/test.html

## Submitting pull requests

1. Create a new branch, please do not work in your `master` branch directly.
Expand All @@ -20,15 +32,15 @@ Please follow jQuery Foundation [JavaScript Style Guide](http://contribute.jquer

## Building with grunt

* install node.js ~0.8
* install node.js v8+
* install grunt-cli ([info](http://gruntjs.com/getting-started#installing-the-cli)):

```
npm install -g grunt-cli
```

* uninstall versions of grunt < 0.4.1
* install grunt 0.4.1 locally into your project folder ([info](http://gruntjs.com/getting-started#working-with-an-existing-grunt-project)):
* uninstall versions of grunt < 0.4
* install grunt 0.4.5 locally into your project folder ([info](http://gruntjs.com/getting-started#working-with-an-existing-grunt-project)):

```
cd path/to/geo
Expand All @@ -50,5 +62,5 @@ npm install grunt-contrib-jshint
grunt
```

Unless you have downloaded a tagged release, grunt will create a test version of jQuery Geo: dist/jquery.geo-1.0.0-test.min.js
Grunt will build the current version of jQuery Geo in the dist folder, e.g., dist/jquery.geo-1.0.0.min.js

10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ $( '#map' ).geomap( );
```html
<div id="map" style="height: 480px;"></div>
<script src="node_modules/jquery/dist/jquery.min.js"></script>
<script src="node_modules/jquery.geo/dist/jquery.geo-1.0.0-rc1.1.min.js"></script>
<script src="node_modules/jquery.geo/dist/jquery.geo.min.js"></script>
<script>
$(function() {
$( "#map" ).geomap( );
Expand All @@ -44,8 +44,8 @@ The following copy-and-paste snippet will help you get started.

```html
<div id="map" style="height: 480px;"></div>
<script src="http://code.jquery.com/jquery-2.2.4.min.js"></script>
<script src="http://code.jquerygeo.com/jquery.geo-1.0.0-rc1.1.min.js"></script>
<script src="http://code.jquery.com/jquery-3.3.1.min.js"></script>
<script src="http://code.jquerygeo.com/jquery.geo-1.1.0.min.js"></script>
<script>
$(function() {
$( "#map" ).geomap( );
Expand All @@ -57,8 +57,8 @@ The following copy-and-paste snippet will help you get started.

You can also download the latest release as a [minified JavaScript file][min] or a [full, uncompressed one][max].

[min]: http://code.jquerygeo.com/jquery.geo-1.0.0-rc1.1.min.js
[max]: http://code.jquerygeo.com/jquery.geo-1.0.0-rc1.1.js
[min]: http://code.jquerygeo.com/jquery.geo-1.1.0.min.js
[max]: http://code.jquerygeo.com/jquery.geo-1.1.0.js

## Documentation

Expand Down
Loading

0 comments on commit a01afea

Please sign in to comment.