Skip to content

Commit

Permalink
badges added to README
Browse files Browse the repository at this point in the history
  • Loading branch information
izelnakri committed Feb 1, 2017
1 parent c2c466c commit 5124f78
Show file tree
Hide file tree
Showing 10 changed files with 28 additions and 30 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![Build Status](https://circleci.com/gh/izelnakri/paper_trail.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/izelnakri/paper_trail.svg?style=shield&circle-token=:circle-token) [![Hex Version](http://img.shields.io/hexpm/v/paper_trail.svg?style=flat)](https://hex.pm/packages/paper_trail) [![Hex docs](http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat)](https://hexdocs.pm/paper_trail)

# How does it work?

PaperTrail lets you record every change in your database in a seperate database table called ```versions```. Library generates a new version record with associated data every time you run ```PaperTrail.insert/1```, ```PaperTrail.update/1``` or ```PaperTrail.delete/1``` functions. Simply these functions wrap your Repo insert, update or destroy actions in a database transaction, so if your database action fails you won't get a new version.
Expand Down Expand Up @@ -118,7 +120,7 @@ The library source code is minimal and tested. It is highly suggested that you c
4. run this command to generate the migration:

```mix papertrail.install```

5. If you do not wish to use `:utc_datetime` for storing your timestamps, change the migration to `:naive_datetime`.
This was changed in Ecto 2.1, see the [CHANGELOG.md](https://github.com/elixir-ecto/ecto/blob/v2.1/CHANGELOG.md) for
more details.
Expand Down
4 changes: 2 additions & 2 deletions doc/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.12.0">
<title>404 – paper_trail v0.5.0</title>
<title>404 – paper_trail v0.5.2</title>
<link rel="stylesheet" href="dist/app-88251e7c81.css" />

<link rel="canonical" href="https://hexdocs.pm/paper_trail/404.html" />
Expand All @@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
paper_trail
</h1>
<h2 class="sidebar-projectVersion">
v0.5.0
v0.5.2
</h2>
</div>

Expand Down
12 changes: 4 additions & 8 deletions doc/Mix.Tasks.Papertrail.Install.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.12.0">
<title>Mix.Tasks.Papertrail.Install – paper_trail v0.5.0</title>
<title>Mix.Tasks.Papertrail.Install – paper_trail v0.5.2</title>
<link rel="stylesheet" href="dist/app-88251e7c81.css" />

<link rel="canonical" href="https://hexdocs.pm/paper_trail/Mix.Tasks.Papertrail.Install.html" />
Expand All @@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
paper_trail
</h1>
<h2 class="sidebar-projectVersion">
v0.5.0
v0.5.2
</h2>
</div>

Expand Down Expand Up @@ -60,7 +60,7 @@ <h2 class="sidebar-projectVersion">


<h1>
<small class="visible-xs">paper_trail v0.5.0</small>
<small class="visible-xs">paper_trail v0.5.2</small>
Mix.Tasks.Papertrail.Install


Expand Down Expand Up @@ -88,9 +88,6 @@ <h2>
<a href="#run/1">run(args)</a>
</div>

<div class="summary-synopsis"><p>Callback implementation for <code class="inline">c:Mix.Task.run/1</code></p>
</div>

</div>

</div>
Expand Down Expand Up @@ -124,8 +121,7 @@ <h1 class="section-heading">
</div>

<section class="docstring">
<p>Callback implementation for <code class="inline">c:Mix.Task.run/1</code>.</p>


</section>
</div>

Expand Down
6 changes: 3 additions & 3 deletions doc/PaperTrail.Migration.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.12.0">
<title>PaperTrail.Migration – paper_trail v0.5.0</title>
<title>PaperTrail.Migration – paper_trail v0.5.2</title>
<link rel="stylesheet" href="dist/app-88251e7c81.css" />

<link rel="canonical" href="https://hexdocs.pm/paper_trail/PaperTrail.Migration.html" />
Expand All @@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
paper_trail
</h1>
<h2 class="sidebar-projectVersion">
v0.5.0
v0.5.2
</h2>
</div>

Expand Down Expand Up @@ -60,7 +60,7 @@ <h2 class="sidebar-projectVersion">


<h1>
<small class="visible-xs">paper_trail v0.5.0</small>
<small class="visible-xs">paper_trail v0.5.2</small>
PaperTrail.Migration


Expand Down
6 changes: 3 additions & 3 deletions doc/PaperTrail.RepoClient.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.12.0">
<title>PaperTrail.RepoClient – paper_trail v0.5.0</title>
<title>PaperTrail.RepoClient – paper_trail v0.5.2</title>
<link rel="stylesheet" href="dist/app-88251e7c81.css" />

<link rel="canonical" href="https://hexdocs.pm/paper_trail/PaperTrail.RepoClient.html" />
Expand All @@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
paper_trail
</h1>
<h2 class="sidebar-projectVersion">
v0.5.0
v0.5.2
</h2>
</div>

Expand Down Expand Up @@ -60,7 +60,7 @@ <h2 class="sidebar-projectVersion">


<h1>
<small class="visible-xs">paper_trail v0.5.0</small>
<small class="visible-xs">paper_trail v0.5.2</small>
PaperTrail.RepoClient


Expand Down
6 changes: 3 additions & 3 deletions doc/PaperTrail.Version.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.12.0">
<title>PaperTrail.Version – paper_trail v0.5.0</title>
<title>PaperTrail.Version – paper_trail v0.5.2</title>
<link rel="stylesheet" href="dist/app-88251e7c81.css" />

<link rel="canonical" href="https://hexdocs.pm/paper_trail/PaperTrail.Version.html" />
Expand All @@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
paper_trail
</h1>
<h2 class="sidebar-projectVersion">
v0.5.0
v0.5.2
</h2>
</div>

Expand Down Expand Up @@ -60,7 +60,7 @@ <h2 class="sidebar-projectVersion">


<h1>
<small class="visible-xs">paper_trail v0.5.0</small>
<small class="visible-xs">paper_trail v0.5.2</small>
PaperTrail.Version


Expand Down
6 changes: 3 additions & 3 deletions doc/PaperTrail.VersionQueries.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.12.0">
<title>PaperTrail.VersionQueries – paper_trail v0.5.0</title>
<title>PaperTrail.VersionQueries – paper_trail v0.5.2</title>
<link rel="stylesheet" href="dist/app-88251e7c81.css" />

<link rel="canonical" href="https://hexdocs.pm/paper_trail/PaperTrail.VersionQueries.html" />
Expand All @@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
paper_trail
</h1>
<h2 class="sidebar-projectVersion">
v0.5.0
v0.5.2
</h2>
</div>

Expand Down Expand Up @@ -60,7 +60,7 @@ <h2 class="sidebar-projectVersion">


<h1>
<small class="visible-xs">paper_trail v0.5.0</small>
<small class="visible-xs">paper_trail v0.5.2</small>
PaperTrail.VersionQueries


Expand Down
6 changes: 3 additions & 3 deletions doc/PaperTrail.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.12.0">
<title>PaperTrail – paper_trail v0.5.0</title>
<title>PaperTrail – paper_trail v0.5.2</title>
<link rel="stylesheet" href="dist/app-88251e7c81.css" />

<link rel="canonical" href="https://hexdocs.pm/paper_trail/PaperTrail.html" />
Expand All @@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
paper_trail
</h1>
<h2 class="sidebar-projectVersion">
v0.5.0
v0.5.2
</h2>
</div>

Expand Down Expand Up @@ -60,7 +60,7 @@ <h2 class="sidebar-projectVersion">


<h1>
<small class="visible-xs">paper_trail v0.5.0</small>
<small class="visible-xs">paper_trail v0.5.2</small>
PaperTrail


Expand Down
6 changes: 3 additions & 3 deletions doc/api-reference.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.12.0">
<title>API Reference – paper_trail v0.5.0</title>
<title>API Reference – paper_trail v0.5.2</title>
<link rel="stylesheet" href="dist/app-88251e7c81.css" />

<link rel="canonical" href="https://hexdocs.pm/paper_trail/api-reference.html" />
Expand All @@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
paper_trail
</h1>
<h2 class="sidebar-projectVersion">
v0.5.0
v0.5.2
</h2>
</div>

Expand Down Expand Up @@ -59,7 +59,7 @@ <h2 class="sidebar-projectVersion">
<div id="content" class="content-inner">

<h1>
<small class="visible-xs">paper_trail v0.5.0</small>
<small class="visible-xs">paper_trail v0.5.2</small>
API Reference
</h1>

Expand Down
2 changes: 1 addition & 1 deletion doc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html>
<head>
<meta charset="utf-8">
<title>paper_trail v0.5.0 – Documentation</title>
<title>paper_trail v0.5.2 – Documentation</title>
<meta http-equiv="refresh" content="0; url=api-reference.html">
<meta name="robots" content="noindex">
<meta name="generator" content="ExDoc v0.12.0">
Expand Down

0 comments on commit 5124f78

Please sign in to comment.