Explorar o código

Merge pull request #12 from pjb3/document_charts

Document how charts work
Andrew Kane %!s(int64=10) %!d(string=hai) anos
pai
achega
46cbc40118
Modificáronse 1 ficheiros con 12 adicións e 0 borrados
  1. 12 0
      README.md

+ 12 - 0
README.md

@@ -133,6 +133,18 @@ Customize user name
 Blazer.user_name = :first_name
 ```
 
+## Charts
+
+Blazer will automatically generate charts based on the types of the columns returned in your query
+
+### Line Chart
+
+If there are at least 2 columns and the first is a timestamp and all other columns are numeric, a line chart will be generated
+
+### Pie Chart
+
+If there are 2 columns and the first column is a string and the second column is a numeric, a pie chart will be generated
+
 ## TODO
 
 - better readme