<commit_before>jQuery.SSR
==========

jQuery plugin to communicate with The Norwegian Mapping Authority's Sentralt
Stedsnavnsregister (SSR). The authorative register for all location names in
all of Norway.

## API

### Search

```javascript
var request = $.fn.SSR('Name of a place');

request.done(function(result) {
  console.log(result.status);    // request status
  console.log(result.stedsnavn); // the resuls
});

request.error(function(error) {
  console.error(error);
});

request.alawsy(function() {
  // this is allways triggered
});
```

### Lookup
<commit_msg>Update README with official documentation links<commit_after>jQuery.SSR
==========

jQuery.SSR is a jQuery plugin for the official location name registry
([SSR](http://www.statkart.no/Kart/Kartverksted/Stedsnavnsok/)) by the Norwegian
Mapping Authority –
[Kartverket](http://kartverket.no/en/About-The-Norwegian-Mapping-Authority/) –
whom bears nationwide responsibility for geographical information, operates the
national property registry and undertakes all property registration in Norway.

### What about Node.JS??

A Node.JS version is located [here](https://github.com/Turistforeningen/ssr.js).

### Official Documentation

* [User guide (PDF)](http://www.kartverket.no/Documents/Kart/Stedsnavn/Veledning_indeksert_stedsnavnsok.pdf)
* [Terms of Service](http://www.statkart.no/Kart/Kartverksted/Lisens/)

## API

### Search

```javascript
var request = $.fn.SSR('Name of a place');

request.done(function(result) {
  console.log(result.status);    // request status
  console.log(result.stedsnavn); // the resuls
});

request.error(function(error) {
  console.error(error);
});

request.alawsy(function() {
  // this is allways triggered
});
```

### Lookup

{'fraction_non_alphanumeric': 0.14680483592400692, 'fraction_numerical': 0.0, 'mean_word_length': 4.931740614334471, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 1, 'lorem ipsum': 0, 'www.': 3, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5022545', 'n_tokens_mistral': 564, 'n_tokens_neox': 546, 'n_words': 134}