You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Updated README and added Jasmine as a dev dependency for Google Maps API testing; moved specs to combined tests/ folder and added Travis CI support for Node testing
Copy file name to clipboardExpand all lines: README.md
+17-27Lines changed: 17 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,8 @@ Wicket is a lightweight library for translating between [Well-Known Text (WKT)](
6
6
* ESRI ArcGIS JavaScript API [(demo)](http://arthur-e.github.com/Wicket/sandbox-arcgis.html)
7
7
* Potentially any other web mapping framework through serialization and de-serialization of GeoJSON (with `JSON.parse`)
8
8
9
+
The core Wicket library and the Leaflet extension are both compatible with Node.js; the Google Maps and ArcGIS API extensions will not work in Node.js because they require a browser.
10
+
9
11
If you are looking for [Apache Wicket](http://wicket.apache.org/), the web-app development framework for Java, [you'll find it here](http://wicket.apache.org/).
10
12
11
13
## License ##
@@ -64,6 +66,21 @@ Use `fromObject()` instead, as in the following example.
**Wicket has zero dependencies**, however, JSON parsing (from strings) is not provided.
72
+
Wicket looks for the function `JSON.parse`, which is provided in most modern browsers (get it with [this library](https://github.com/douglascrockford/JSON-js/blob/master/json2.js), if you need to support older browsers).
73
+
74
+
Minified versions can be generated via:
75
+
76
+
npm run build
77
+
78
+
### Testing ###
79
+
80
+
npm test
81
+
82
+
The Google Maps API extension cannot be tested by Node.js at the command line; it requires a browser. The Google Maps API tests are run by Jasmine; navigate to the file `tests/wicket-gmap3.html` in a web browser.
83
+
67
84
## Documentation ##
68
85
69
86
Read the documentation [here](http://arthur-e.github.io/Wicket/doc/out/). Documentation can be generated with [JSDoc 3](https://github.com/jsdoc3/jsdoc).
@@ -78,33 +95,6 @@ Or, with Node installed:
78
95
79
96
Either way, make sure you invoke `jsdoc` from a directory in which you have write access; it will output documentation to your current working directory.
80
97
81
-
## Dependencies and Build Information ##
82
-
83
-
**Wicket has zero dependencies**, however, JSON parsing (from strings) is not provided.
84
-
Wicket looks for the function `JSON.parse`, which is provided in most modern browsers (get it with [this library](https://github.com/douglascrockford/JSON-js/blob/master/json2.js), if you need to support older browsers).
85
-
86
-
**Minified versions** can be generated with `uglify-js` (`sudo npm install uglify-js -g`):
Once you have Jasmine installed and the paths match those expected in `tests/SpecRunner.html` (or you changed them to match your Jasmine installation) then just point your browser to `localhost/static/wicket/tests/SpecRunner.html`.
0 commit comments