Skip to content

Commit

Permalink
Fixed readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Tyler-pierce committed Jan 13, 2018
1 parent ac90c9b commit 02539f0
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -75,7 +75,7 @@ To add and query stats from memory you will need Simple Stats supervisor added t
...
]
```
** Hint ** You needent set up any kind of repo and can choose to only to keep stats in memory
**Hint** You needent set up any kind of repo and can choose to only keep stats in memory


## Usage
Expand All @@ -96,7 +96,7 @@ SSX.stat("about page visit", :daily) |> SSX.save()
{:ok, %SimpleStatEx.SimpleStat{ ... }}
```

The allowed atoms for time periods are in the documentation.
The currently allowed atoms for time periods are :minute, :second, :hourly, :daily, :weekly, :monthly, :yearly.

You can also save to memory easily by making use of the piping convenience function (make sure to do optional setup):

Expand Down
8 changes: 8 additions & 0 deletions config/config.exs
Expand Up @@ -2,6 +2,14 @@
# and its dependencies with the aid of the Mix.Config module.
use Mix.Config

config :simplestatex, SimpleStatEx.Repo,
adapter: Ecto.Adapters.Postgres,
username: "simplestats",
password: "simplestats",
database: "simplestats",
hostname: "localhost",
pool_size: 10

# This configuration is loaded before any dependency and is restricted
# to this project. If another project depends on this project, this
# file won't be loaded nor affect the parent project. For this reason,
Expand Down
6 changes: 3 additions & 3 deletions mix.exs
Expand Up @@ -7,7 +7,7 @@ defmodule SimpleStatEx.Mixfile do
version: "0.1.0",
elixir: "~> 1.5",
start_permanent: Mix.env == :prod,
deps: deps()
deps: deps(),
description: description(),
package: package()
]
Expand All @@ -24,8 +24,8 @@ defmodule SimpleStatEx.Mixfile do
defp deps do
[
{:phoenix_ecto, "~> 3.0"},
{:timex, "~> 3.1.15", override: true},
{:timex_ecto, "~> 3.1.1", override: true},
{:timex, "~> 3.1"},
{:timex_ecto, "~> 3.1"},

{:ex_doc, "~> 0.16", only: :dev, runtime: false}
]
Expand Down

0 comments on commit 02539f0

Please sign in to comment.