v1.0.1 - see CHANGELOG

romansanchez · Jul 25, 2014 · a972933 · a972933
1 parent 3b88ab7
commit a972933
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,11 @@
+# Changelog
+
+## 1.0.1 - Jul 24 2014
+- Add documentation to show how to configure results. 
+- Update the required configs/documentation
+- Update css class names
+- Add monitoring plug
+- Add changelog
+
+## 1.0.0 - Jun 15 2014
+- Initial release
diff --git a/README.md b/README.md
@@ -1,37 +1,44 @@
 Calaca
 =========
 
-Calaca is a simple, easy to use search client for ElasticSearch. It's made for you if all you need to do is quick searches for your documents and don't need anything fancy or hard to setup, use. 
-  - Quick and easy search
+Calaca is a simple, easy to use search client for Elasticsearch. It's made for you if all you need to do is quick searches for your documents and don't need anything fancy or hard to setup, use. 
+  - Quick, easy and instant search
   - Looks good
   - Minimum configs required
 
 
 ![calaca-screenshot](https://s3.amazonaws.com/calaca/calaca.png "Calaca screenshot")
 
-Dependencies
+Dependencies(Already included)
 ----
   - angular.js
   - elasticsearch.angular.js
 
 Get Started
 ----
-In **calaca.js** change the configs to match your ElasticSearch cluster. 
+In **calaca.js** change the configs to match your Elasticsearch cluster. 
 ```js
 /* Configs */
 var indexName = "name";
 var docType = "type";
 var maxResultsSize = 10;
 var host = "localhost";
-var port = "9200";
+var port = 9200;
+```
+
+In **index.html** append to ```result.``` the field name you want to show from your es document.
+Using dot notation, you can access nested fields like such ```result.transactions.time ```.
+```html
+<h2>{{result.name}}</h2>
+<p>{{result.description}}</p>
 ```
 
 Styling
 ----
 You can easily change the look and feel of Calaca by implementing the below CSS classes. 
 ```css
 .title
-.searchBox
+.search-box
 .no-results
 .results
 .result
@@ -41,7 +48,7 @@ You can easily change the look and feel of Calaca by implementing the below CSS
 Version
 ----
 
-1.0.0
+1.0.1
 
 Author
 ----
@@ -51,6 +58,8 @@ Roman Sanchez
 
 [@rooomansanchez]
 
+Need Elasticsearch cluster monitoring and alerting? Check out [Pulse].
+
 
 License
 ----
@@ -59,3 +68,4 @@ MIT
 
 [romansanchez.me]:http://romansanchez.me
 [@rooomansanchez]:http://twitter.com/rooomansanchez
+[Pulse]:https://sweltering-fire-2945.firebaseapp.com/
diff --git a/css/calaca.css b/css/calaca.css
@@ -1,6 +1,6 @@
 /*
  * Calaca
- * Simple search client for ElasticSearch
+ * Simple search client for Elasticsearch
  * https://github.com/romansanchez/Calaca
  * Author - Roman Sanchez
  * http://romansanchez.me
@@ -32,15 +32,15 @@ body {
   text-align: center;
   padding-top: 70px;
 }
-.searchBoxContainer {
+.search-box-container {
   width: 860px;
   height: 69px;
   margin-left: auto;
   margin-right: auto;
   margin-top: 60px;
   border-radius: 5px;
 }
-.searchBox {
+.search-box {
   width: 812px;
   height: 100%;
   color: #000;
@@ -69,7 +69,7 @@ body {
 /* Header */
 
 /* Results */
-.resultsContainer {
+.results-container {
   height: 100%;
   width: 100%;
   padding-top: 30px;
@@ -87,6 +87,9 @@ body {
   background-color: #fff;
   border-radius: 5px;
 }
+/* Results */
+
+/* Result */
 .result {
   margin-bottom: 10px;
   padding: 10px;
@@ -97,5 +100,5 @@ body {
   color: #ed4877;
   margin-bottom: 5px;
 }
-/* Results */
+/* Result */
 
diff --git a/index.html b/index.html
@@ -2,7 +2,7 @@
 <html lang='en'>
 <head>
     <meta charset='utf-8'>
-    <title>Calaca | Simple search client for ElasticSearch</title>
+    <title>Calaca | Simple search client for Elasticsearch</title>
     <link rel='stylesheet' href='css/reset.css'>
     <link rel='stylesheet' href='css/calaca.css'>
     <!--[if IE]>
@@ -14,13 +14,13 @@
 <!-- Title and search box -->
 <header class="jumbotron">
   <h1 class="title">Calaca</h1>
-  <div class="searchBoxContainer">
-    <input type='text' class="searchBox" placeholder="Search" autofocus ng-model='query' ng-change="search()">
+  <div class="search-box-container">
+    <input type='text' class="search-box" placeholder="Search" autofocus ng-model='query' ng-change="search()">
   </div>
 </header>
 
 <!-- Listing of search results -->
-<main class="resultsContainer">
+<main class="results-container">
   <section class='results'>
     <p class='no-results' ng-hide='results.length'>No Results</p>
     <article class='result' ng-cloak ng-repeat='result in results track by $id(result)'>

diff --git a/js/calaca.js b/js/calaca.js
@@ -15,7 +15,7 @@ var indexName = "name";
 var docType = "type";
 var maxResultsSize = 10;
 var host = "localhost";
-var port = "9200";
+var port = 9200;
 
 /* Module */
 window.Calaca = angular.module('calaca', ['elasticsearch'],
@@ -93,6 +93,5 @@ Calaca.controller('calacaCtrl', ['calacaService', '$scope', '$location', functio
             });
         };
 
-
     }]
 );