<commit_before>geo-proximity
=====================

[![Build Status](https://travis-ci.org/arjunmehta/node-geo-proximity.svg?branch=master)](https://travis-ci.org/arjunmehta/node-geo-proximity)

**Note:** *The API for v2.x.x has been completely rewritten!*<br/>
**Note:** *This module requires a [Redis](http://redis.io) server to be accessible to your Node environment.*

![geo-proximity title image](https://raw.githubusercontent.com/arjunmehta/node-geo-proximity/image/image/splash.png)

This Node module provides everything you need to get proximity information for geo locations. More specifically:

- **Fast querying of nearby locations to a point within a set. Fast like redis is fast.**
- **Basic management (addition, querying and removal) of sets of named geo locations.**
- **A simple, easy to use, scalable interface.**
- **Distributable methods (for browser based clients) alleviate computational load on server.**

It should be noted that the method used here is not the most precise, but the query is very fast, and should be appropriate for most consumer applications looking for this basic function. [Read more about how this module works](http://gis.stackexchange.com/questions/18330/would-it-be-possible-to-use-geohash-for-proximity-searches/92331#92331).

## Installation

```bash
npm install geo-proximity
```

## Basic Usage
Usage of this module should be extremely simple. Just make sure that your Redis server is accessible to your Node environment. Because this module uses Redis as a store, almost all methods have integrated error handling for queries.

### Include and Initialize

Include and initialize this module with a node-redis client instance.

```javascript
var redis = require('redis'),
    client = redis.createClient()
<commit_msg>Adding deprecated message.<commit_after>## Module Deprecated: Use [GeoRedis](https://github.com/arjunmehta/node-georedis)

geo-proximity
=====================

[![Build Status](https://travis-ci.org/arjunmehta/node-geo-proximity.svg?branch=master)](https://travis-ci.org/arjunmehta/node-geo-proximity)

**Note:** *This module requires a [Redis](http://redis.io) server to be accessible to your Node environment.*

![geo-proximity title image](https://raw.githubusercontent.com/arjunmehta/node-geo-proximity/image/image/splash.png)

This Node module provides everything you need to get proximity information for geo locations. More specifically:

- **Fast querying of nearby locations to a point within a set. Fast like redis is fast.**
- **Basic management (addition, querying and removal) of sets of named geo locations.**
- **A simple, easy to use, scalable interface.**
- **Distributable methods (for browser based clients) alleviate computational load on server.**

It should be noted that the method used here is not the most precise, but the query is very fast, and should be appropriate for most consumer applications looking for this basic function. [Read more about how this module works](http://gis.stackexchange.com/questions/18330/would-it-be-possible-to-use-geohash-for-proximity-searches/92331#92331).

## Installation

```bash
npm install geo-proximity
```

## Basic Usage
Usage of this module should be extremely simple. Just make sure that your Redis server is accessible to your Node environment. Because this module uses Redis as a store, almost all methods have integrated error handling for queries.

### Include and Initialize

Include and initialize this module with a node-redis client instance.

```javascript
var redis = require('redis'),
    client = redis.createClient()

{'fraction_non_alphanumeric': 0.11095544970579994, 'fraction_numerical': 0.008685906416363126, 'mean_word_length': 4.989932885906041, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 7, 'lorem ipsum': 0, 'www.': 0, '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': '4834059', 'n_tokens_mistral': 1041, 'n_tokens_neox': 972, 'n_words': 388}