update: fixes for v0.0.1

codediodeio · codediodeio · commit 577e85d44499 · 2018-07-08T17:38:15.000-07:00
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 node_modules/
 .rpt2_cache/
-dist/
+dist/
+coverage/
diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
-# GeoFireX - Realitme GeoLocation with Firestore & RxJS
+# GeoFireX
 
-Live Demo
+Realtime Geolocation with Firestore & RxJS
+
+[Live Demo](https://geo-test-c92e4.firebaseapp.com)
 
 ## QuickStart
 
@@ -20,7 +22,7 @@ import * as geofirex from 'geofirex';
 const geo = geofirex.init(firebase);
 ```
 
-First, you'll need to add some geolocation data in your databse. A `collection` creates a reference to Firestore (just like the SDK), but with some extra geoquery features. The `geohash` method returns a class that helps you create geolocation data.
+First, you'll need to add some geolocation data in your database. A `collection` creates a reference to Firestore (just like the SDK), but with some extra geoquery features. The `geohash` method returns a class that helps you create geolocation data.
 
 ```ts
 const cities = geo.collection('cities');
@@ -49,7 +51,7 @@ query.subscribe(console.log);
 
 ## API
 
-Coming soon...
+Better docs soon...
 
 ### `init`
 
diff --git a/coverage/clover.xml b/coverage/clover.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<coverage generated="1531094018783" clover="3.2.0">
-  <project timestamp="1531094018784" name="All files">
+<coverage generated="1531094579961" clover="3.2.0">
+  <project timestamp="1531094579961" name="All files">
     <metrics statements="287" coveredstatements="167" conditionals="68" coveredconditionals="27" methods="59" coveredmethods="41" elements="414" coveredelements="235" complexity="0" loc="287" ncloc="287" packages="2" files="5" classes="5">
       <package name="spec">
         <metrics statements="1" coveredstatements="1" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0"/>
diff --git a/coverage/lcov-report/index.html b/coverage/lcov-report/index.html
@@ -93,7 +93,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Sun Jul 08 2018 16:53:38 GMT-0700 (MST)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Sun Jul 08 2018 17:02:59 GMT-0700 (MST)
 </div>
 </div>
 <script src="prettify.js"></script>
diff --git a/coverage/lcov-report/spec/index.html b/coverage/lcov-report/spec/index.html
@@ -80,7 +80,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Sun Jul 08 2018 16:53:38 GMT-0700 (MST)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Sun Jul 08 2018 17:02:59 GMT-0700 (MST)
 </div>
 </div>
 <script src="../prettify.js"></script>
diff --git a/coverage/lcov-report/spec/util.ts.html b/coverage/lcov-report/spec/util.ts.html
@@ -76,7 +76,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Sun Jul 08 2018 16:53:38 GMT-0700 (MST)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Sun Jul 08 2018 17:02:59 GMT-0700 (MST)
 </div>
 </div>
 <script src="../prettify.js"></script>
diff --git a/coverage/lcov-report/src/client.ts.html b/coverage/lcov-report/src/client.ts.html
@@ -157,7 +157,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Sun Jul 08 2018 16:53:38 GMT-0700 (MST)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Sun Jul 08 2018 17:02:59 GMT-0700 (MST)
 </div>
 </div>
 <script src="../prettify.js"></script>
diff --git a/coverage/lcov-report/src/collection.ts.html b/coverage/lcov-report/src/collection.ts.html
@@ -721,7 +721,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Sun Jul 08 2018 16:53:38 GMT-0700 (MST)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Sun Jul 08 2018 17:02:59 GMT-0700 (MST)
 </div>
 </div>
 <script src="../prettify.js"></script>
diff --git a/coverage/lcov-report/src/geohash.ts.html b/coverage/lcov-report/src/geohash.ts.html
@@ -376,7 +376,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Sun Jul 08 2018 16:53:38 GMT-0700 (MST)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Sun Jul 08 2018 17:02:59 GMT-0700 (MST)
 </div>
 </div>
 <script src="../prettify.js"></script>
diff --git a/coverage/lcov-report/src/index.html b/coverage/lcov-report/src/index.html
@@ -119,7 +119,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Sun Jul 08 2018 16:53:38 GMT-0700 (MST)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Sun Jul 08 2018 17:02:59 GMT-0700 (MST)
 </div>
 </div>
 <script src="../prettify.js"></script>
diff --git a/coverage/lcov-report/src/util.ts.html b/coverage/lcov-report/src/util.ts.html
@@ -1627,7 +1627,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Sun Jul 08 2018 16:53:38 GMT-0700 (MST)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Sun Jul 08 2018 17:02:59 GMT-0700 (MST)
 </div>
 </div>
 <script src="../prettify.js"></script>
diff --git a/dist/collection.d.ts b/dist/collection.d.ts
@@ -77,7 +77,7 @@ export declare class GeoFireCollectionRef {
 export declare function toGeoJSON(field: string, includeProps?: boolean): any;
 /**
  * Helper function to convert any query from an RxJS Observable to a Promise
- * Example usage: await get( db.within(a, b, c) )
+ * Example usage: await get( collection.within(a, b, c) )
  * @param  {Observable<any>} observable
  * @returns {Promise<any>}
  */
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/spec/main.spec.ts b/spec/main.spec.ts
