Commit fa5d2336 authored by Mikko Ahlroth's avatar Mikko Ahlroth

Doc and misc fixes

* Add more info to README
* Fix errors in API docs
* Add clarification of highlighted XP to profile view
* Add link to example stats to front page

Fixes #1
Fixes #2
Fixes #4
Fixes #5
Fixes #6
parent 8af1928d
# CodeStats
# Code::Stats
Code::Stats is a free stats tracking service for programmers: [https://codestats.net/](https://codestats.net/).
This repository contains the Phoenix application that implements the service backend.
## Installation for development
To start your Phoenix app:
......@@ -7,11 +13,11 @@ To start your Phoenix app:
* Install Node.js dependencies with `npm install`
* Start Phoenix endpoint with `mix phoenix.server`
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
Now you can visit [`localhost:5000`](http://localhost:5000) from your browser.
Ready to run in production? Please [check our deployment guides](http://www.phoenixframework.org/docs/deployment).
Ready to run in production? Please [check the Phoenix deployment guides](http://www.phoenixframework.org/docs/deployment).
## Learn more
## Learn more about Phoenix
* Official website: http://www.phoenixframework.org/
* Guides: http://phoenixframework.org/docs/overview
......
......@@ -3,7 +3,7 @@ defmodule CodeStats.Mixfile do
def project do
[app: :code_stats,
version: "1.2.0",
version: "1.2.1",
elixir: "~> 1.2",
elixirc_paths: elixirc_paths(Mix.env),
compilers: [:phoenix, :gettext] ++ Mix.compilers,
......
......@@ -93,7 +93,7 @@
In all API requests that require authentication, the token must be added using the HTTP header <code>X-API-Token</code>. Here is an example request sent with the token (as printed by curl):
</p>
<pre><code>&gt; POST /api/my/pulse HTTP/1.1
<pre><code>&gt; POST /api/my/pulses HTTP/1.1
&gt; Host: codestats.net:443
&gt; User-Agent: curl/7.43.0
&gt; Accept: */*
......@@ -119,6 +119,10 @@
Adds a new <em>Pulse</em> to the system. The client should send a pulse periodically when the user is programming. The payload should be a list of languages and their accumulated XP since the last successful pulse. The pulse should also contain a <code>coded_at</code> timestamp that signifies when the pulse was generated. This allows sending the pulse later, if the Internet connection is momentarily cut.
</p>
<p>
Note: The <code>coded_at</code> timestamp must be no more than 2 weeks old. Any older timestamps will result in an error. Timestamps in the future will be ignored, their <code>coded_at</code> will be set to the current moment.
</p>
<p>
Example payload:
</p>
......
......@@ -24,7 +24,18 @@
<h2>Changelog</h2>
<h3>1.2.0 – Scaling back levels</h3>
<h3>1.2.1 – 2016-05-31 – Small fixes</h3>
<p>
<ul>
<li></li>
<li></li>
<li></li>
<li></li>
</ul>
</p>
<h3>1.2.0 – 2016-05-31 – Scaling back levels</h3>
<p>
<ul>
......@@ -33,7 +44,7 @@
</ul>
</p>
<h3>1.1.1 – Clock drift</h3>
<h3>1.1.1 – 2016-05-30 – Clock drift</h3>
<p>
<ul>
......@@ -41,7 +52,7 @@
</ul>
</p>
<h3>1.1.0 – First public release</h3>
<h3>1.1.0 – 2016-05-30 – First public release</h3>
<p>
Implemented <em>everything</em>. 🎉
......
......@@ -7,7 +7,7 @@
<div class="col-xs-12 col-lg-4">
<h4>Write code</h4>
<p>
Code::Stats currently has a plugin for the Atom editor. If you wish to make one for your own favourite editor, you are free to check out the <a href="<%= page_path(@conn, :api_docs) %>">API documentation</a>!
Code::Stats currently has a <a href="<%= page_path(@conn, :plugins) %>">plugin for the Atom editor</a>. If you wish to make one for your own favourite editor, you are free to check out the <a href="<%= page_path(@conn, :api_docs) %>">API documentation</a>!
</p>
</div>
......@@ -23,6 +23,10 @@
<p>
Show your personal statistics page to your friends and compare your progress with others. Maybe even have a competition! Or, if you wish, you can keep all your information private and enjoy it in secret.
</p>
<p>
<a href="<%= profile_path(@conn, :profile, "Nicd") %>">See an example profile →</a>
</p>
</div>
</div>
......
......@@ -72,6 +72,20 @@
</div>
<% end %>
</div>
<div class="row">
<div class="col-xs-12">
<hr />
<p>
<center>
<small>
XP gained in the last 12 hours is highlighted.
</small>
</center>
</p>
</div>
</div>
<% end %>
<%= if not Enum.empty?(@more_xps) do %>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment