Skip to content

Commit

Permalink
Merge b17b883 into 60a5a0c
Browse files Browse the repository at this point in the history
  • Loading branch information
Jacob Wenger committed Aug 24, 2014
2 parents 60a5a0c + b17b883 commit 333a6fe
Show file tree
Hide file tree
Showing 18 changed files with 78 additions and 1,503 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
dist/
node_modules/
bower_components/
tests/coverage/
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ install:
- npm install
- bower install
script:
- npm test
- npm run travis
after_script:
- cat ./tests/coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js
46 changes: 0 additions & 46 deletions CHANGELOG.md

This file was deleted.

21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# GeoFire for JavaScript — Realtime location queries with Firebase

[![Build Status](https://travis-ci.org/firebase/geofire-js.svg)](https://travis-ci.org/firebase/geofire-js)
[![Coverage Status](https://img.shields.io/coveralls/firebase/geofire-js.svg)](https://coveralls.io/r/firebase/geofire-js)
[![Build Status](https://travis-ci.org/firebase/geofire-js.svg?branch=master)](https://travis-ci.org/firebase/geofire-js)
[![Coverage Status](https://img.shields.io/coveralls/firebase/geofire-js.svg?branch=master)](https://coveralls.io/r/firebase/geofire-js)
[![Version](https://badge.fury.io/gh/firebase%2Fgeofire-js.svg)](http://badge.fury.io/gh/firebase%2Fgeofire-js)

GeoFire is an open-source library that allows you to store and query a set of keys based on their
Expand Down Expand Up @@ -50,7 +50,7 @@ using security rules.

GeoFire 3.x has the same API as 2.x but uses a different underlying data structure to store its
location data. If you are currently using 2.x and want to upgrade to 3.x, you must run the
[GeoFire 3.x migration script](https://github.com/firebase/geofire/blob/master/migration/migrateToV3.js)
[GeoFire 3.x migration script](https://github.com/firebase/geofire-js/blob/master/migration/migrateToV3.js)
on your Firebase. This Node.js script only needs to be run one time and should take only a few seconds
to minutes depending on the size of your data. To run the script, copy the files in this repo's
`/migration/` folder to your machine and run the following commands:
Expand All @@ -69,17 +69,19 @@ In order to use GeoFire in your project, you need to include the following files
<script src="rsvp.min.js"></script>

<!-- Firebase -->
<script src="https://cdn.firebase.com/js/client/1.0.19/firebase.js"></script>
<script src="https://cdn.firebase.com/js/client/1.0.21/firebase.js"></script>

<!-- GeoFire -->
<script src="https://cdn.firebase.com/libs/geofire/3.0.0/geofire.min.js"></script>
```

Use the URL above to download both the minified and non-minified versions of GeoFire from the Firebase CDN. You can also download them from the
`/dist/` directory of this GitHub repository. [Firebase](https://www.firebase.com/docs/web-quickstart.html?utm_source=geofire-js)
and [RSVP](https://github.com/tildeio/rsvp.js/) can be downloaded directly from their respective websites.
Use the URL above to download both the minified and non-minified versions of GeoFire from the
Firebase CDN. You can also download them from the
[releases page of this GitHub repository](https://github.com/firebase/geofire-js/releases).
[Firebase](https://www.firebase.com/docs/web/quickstart.html?utm_source=geofire-js) and
[RSVP](https://github.com/tildeio/rsvp.js/) can be downloaded directly from their respective websites.

You can also install GeoFire via npm or Bower and the dependencies will be downloaded automatically:
You can also install GeoFire via npm or Bower and its dependencies will be downloaded automatically:

```bash
$ npm install geofire --save
Expand Down Expand Up @@ -131,7 +133,8 @@ value. `location` must have the form `[latitude, longitude]`.

Returns a promise which is fulfilled when the new location has been synchronized with the Firebase servers.

`key` must be a string and a [valid Firebase key name](https://www.firebase.com/docs/creating-references.html?utm_source=geofire-js)
`key` must be a string and a
[valid Firebase key name](https://www.firebase.com/docs/web/guide/understanding-data.html#section-creating-references?utm_source=geofire-js)

```JavaScript
geoFire.set("some_key", [37.79, -122.41]).then(function() {
Expand Down
4 changes: 2 additions & 2 deletions bower.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "geofire",
"description": "Location-based querying and filtering using Firebase",
"version": "3.0.0",
"version": "0.0.0",
"authors": [
"Firebase <support@firebase.com> (https://www.firebase.com/)"
],
Expand Down Expand Up @@ -30,7 +30,7 @@
"firebase.json",
"package.json",
"gulpfile.js",
"release.sh"
"changelog.txt"
],
"dependencies": {
"firebase": "1.0.x",
Expand Down
14 changes: 8 additions & 6 deletions build/header
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
/*! GeoFire is a JavaScript library that allows you to store and query a set
* of keys based on their geographic location. GeoFire uses Firebase for data
* storage, allowing query results to be updated in realtime as they change.
/*! GeoFire is an open-source library that allows you to store and query a set
* of keys based on their geographic location. At its heart, GeoFire simply
* stores locations with string keys. Its main benefit, however, is the
* possibility of retrieving only those keys within a given geographic area -
* all in realtime.
*
* GeoFire 3.0.0
* https://github.com/firebase/geofire/
* License: MIT
* GeoFire 0.0.0
* https://github.com/firebase/geofire-js/
* License: MIT
*/

// Include RSVP if this is being run in node
Expand Down
Empty file added changelog.txt
Empty file.
Loading

0 comments on commit 333a6fe

Please sign in to comment.