change username Postgres config for consistency and remove unnecessary…

README.md

@@ -5,3 +5,36 @@ Alt Tracker is a beautiful, simple, cryptocurrency portfolio management tool wri
 ## Keys
 
 - `:open_exchange_key` - for querying currency data through [open exchange rates](https://openexchangerates.org/account/app-ids)
+
+## Getting started
+
+Once downloaded, follow these steps in order to get the app up and running on your local machine.
+
+- Install dependencies:
+
+```
+$ mix do deps.get, deps.compile
+$ cd assets && npm install && node node_modules/brunch/bin/brunch build
+```
+
+- Change `Postgres` username in _/config/dev.exs_ to your own username.
+
+- Create the database:
+
+```
+ $ mix ecto.create
+```
+
+- Migrate database:
+
+```
+$ mix ecto.migrate
+```
+
+- Start your server:
+
+```
+$ mix phx.server
+```
+
+You should now have the application running on port `4000`: _localhost:4000_

config/dev.exs

@@ -51,10 +51,8 @@ config :phoenix, :stacktrace_depth, 20
 # Configure your database
 config :cryptofolio, Cryptofolio.Repo,
   adapter: Ecto.Adapters.Postgres,
-  username: "postgres",
+  username: "username",
   password: "password",
   database: "cryptofolio_dev",
   hostname: "localhost",
   pool_size: 10
-
-import_config "dev.secret.exs"