Skip to content

Commit

Permalink
further docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pmeisen committed Apr 12, 2017
1 parent e0a390c commit e513047
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 17 deletions.
7 changes: 6 additions & 1 deletion documentation/snippets/language-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,9 @@ var breinify = new Breinify({
'apiKey': '938D-3120-64DD-413F-BB55-6573-90CE-473A',
'secret': 'utakxp7sm6weo5gvk7cytw=='
});
```
```

<blockquote class="lang-specific javascript--node">
<p>Within this documentation the usage of the variable <code class="prettyprint">breinify</code> indicates that
a configured instance of <code class="prettyprint">Breinify</code> is used.</p>
</blockquote>
4 changes: 2 additions & 2 deletions documentation/snippets/language-geocoding.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
>
```javascript--browser
Breinify.temporalData({ location: { text: 'Bemidji' }}, function(data) {
```javascript--node
breinify.temporalData({ location: { text: 'Bemidji' }}, function(data) {
// the location will be resolved to Bemidji, Minnesota, USA
console.log(data);
});
Expand Down
9 changes: 4 additions & 5 deletions documentation/snippets/language-request-temporal-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ of the <code class="prettyprint">temporalData</code> method.</p>
```javascript--node
var latitude = 37.7749;
var longitude = -122.4194;
Breinify.temporalData(latitude, longitude, function(data) {
breinify.temporalData(latitude, longitude, function(data) {
console.log(data);
});
```
Expand All @@ -25,7 +25,7 @@ Breinify.temporalData(latitude, longitude, function(data) {
>
```javascript--node
var ipAddress = '72.229.28.185';
Breinify.temporalData(ipAddress, function(data) {
breinify.temporalData(ipAddress, function(data) {
console.log(data);
});
```
Expand All @@ -39,18 +39,17 @@ The further usage examples illustrate different possibilities.</p>

>
```javascript--node
// you can also pass in a more complex location object
var loc1 = {
'text': 'San Diego'
};
Breinify.temporalData({ 'location': loc1 }, function(data) {
breinify.temporalData({ 'location': loc1 }, function(data) {
console.log(data);
});
var loc2 = {
'latitude': 37.7749,
'longitude': -122.4194
};
Breinify.temporalData({ 'location': loc2 }, function(data) {
breinify.temporalData({ 'location': loc2 }, function(data) {
console.log(data);
});
```
13 changes: 5 additions & 8 deletions documentation/snippets/language-reverse-geocoding.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ and use the resolved information.</p>

>
```javascript--node
Breinify.temporalData(37.7609295, -122.4194155, function(data) {
breinify.temporalData(37.7609295, -122.4194155, function(data) {
console.log(data);
});
```
Expand All @@ -23,16 +23,13 @@ var loc = {
longitude: -111.8910,
shapeTypes: ['CITY']
};
Breinify.temporalData({ location: loc }, function(data) {
breinify.temporalData({ location: loc }, function(data) {
console.log(data);
});
```

<blockquote class="lang-specific javascript--node">
<p>There are examples available on runkit. Have a look:
<ul>
<li><a target="_blank" href="https://runkit.com/breinify-stage/reverse-geocoding-lati-long">Coordinations Example</a></li>
<li><a target="_blank" href="https://runkit.com/breinify-stage/reverse-geocoding-geojson">GeoJson Example</a></li>
</ul>
</p>
<p>There are examples available on runkit. Have a look at
<a target="_blank" href="https://runkit.com/breinify-stage/reverse-geocoding-lati-long">Coordinations Example</a> and
<a target="_blank" href="https://runkit.com/breinify-stage/reverse-geocoding-geojson">GeoJson Example</a>.</p>
</blockquote>
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "breinify-node",
"version": "1.0.12",
"version": "1.0.15",
"description": "This is a JavaScript library simplifying the usage of the Breinify API specifically for node",
"authors": [
"Diane Keng <[email protected]>",
Expand Down

0 comments on commit e513047

Please sign in to comment.