Skip to content

Commit

Permalink
Added changelog, updated README, version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
gig3m committed Apr 21, 2013
1 parent afe43ca commit c1f1223
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 8 deletions.
23 changes: 18 additions & 5 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,34 @@ Jeepstatus.com will report to you the status of a Jeep whose information is foun

Chrysler's VOTS relies on asyncronous calls to an address that returns an invalid, but close, JSON response. By highjacking the async call and performing a lookup on an array, we can get a more specific explanation of where the vehicle is actually reported as being.

This repository more specifically runs on (taken from the composer.json file):
### Requirments/Built On

This service is built on [Slim Framework](https://github.com/codeguy/Slim) with the addition of [Slim Extras](https://github.com/codeguy/Slim-Extras), [Twig](http://twig.sensiolabs.org/) for templating, and [Predis](https://github.com/nrk/predis) for caching in a redis server.

You should install the components via composer. Outside of that (and a webserver with rewrite on) you only need a copy of redis running.

``` json
{
"name": "jeepsomething",
"name": "jeepstatus",
"require": {
"slim/slim": "2.*",
"slim/extras": "*",
"twig/twig": "*"
"twig/twig": "*",
"predis/predis": "0.8.*@dev"
}
}
```
### Warranty

There is none. Use this tool at your own peril. All actual information (save the lookup table) comes directly from Chrysler. Here be dragons.
### Changelog

#### 0.2
52 times a day is a lot
Not wanting to bombard Chrysler's VOTS service every 5 minutes from the same address, implemented a redis server to cache the json result for 20 minutes. The interval does not grow or shrink depending on how many times you hit the url. 20 minutes. Go drink a coffee or beer or something.

#### 0.1
Initial Creation:
JeepStatus is born from the exhaustion of looking at JSON backend code provided by Chrysler than doesn't actually show all the information they are providing. By coupling the actual data response with a dealer provdied list (available on many jeep websites) we can cross refence and get a better description of where the vehicle actually is.


### License

Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "jeepsomething",
"name": "jeepstatus",
"require": {
"slim/slim": "2.*",
"slim/extras": "*",
Expand Down
8 changes: 8 additions & 0 deletions public/index.php
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,14 @@

});

// // Changelog
$app->get('/changelog', function () use ($app) {

//Do something
$app->render('changelog.twig');

});

// // Home
$app->get('/', function () use ($app) {

Expand Down
4 changes: 2 additions & 2 deletions views/application.twig
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,15 @@
<div class="container">
<div class="sixteen columns">
<h1 class="remove-bottom" style="margin-top: 40px">Jeep Status</h1>
<h5>Version 0.1</h5>
<h5>Version 0.2</h5>
<hr />
</div>

{% block container %}{% endblock container %}

<div class="sixteen columns">
<p>
Question? Comments? <a href='&#109;&#97;&#105;&#108;&#116;&#111;&#58;&#107;&#121;&#108;&#101;&#64;&#97;&#114;&#114;&#105;&#110;&#103;&#116;&#111;&#110;&#46;&#99;&#111;'>Email me.</a>
Question? Comments? Broken? <a href='&#109;&#97;&#105;&#108;&#116;&#111;&#58;&#107;&#121;&#108;&#101;&#64;&#97;&#114;&#114;&#105;&#110;&#103;&#116;&#111;&#110;&#46;&#99;&#111;'>Email me.</a>
</p>
</div>

Expand Down
26 changes: 26 additions & 0 deletions views/changelog.twig
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{% extends "application.twig" %}

{% block container %}

<div class="six columns offset-by-five">
<p>
<strong>Changelog</strong>
</p>

<p>
<strong>0.2</strong><br>
52 times a day is a lot <br>
Not wanting to bombard Chrysler's VOTS service every 5 minutes from the same address, implemented a redis server to cache the json result for 20 minutes. The interval does not grow or shrink depending on how many times you hit the url. 20 minutes. Go drink a coffee or beer or something.
</p>

<p>
<strong>0.1</strong><br>
Initial Creation: <br>
JeepStatus is born from the exhaustion of looking at JSON backend code provided by Chrysler than doesn't actually show all the information they are providing. By coupling the actual data response with a dealer provdied list (available on many jeep websites) we can cross refence and get a better description of where the vehicle actually is.
</p>

</div>



{% endblock container %}

0 comments on commit c1f1223

Please sign in to comment.