Browse Source

minor edits

Derek Schultz 2 years ago
parent
commit
514d85628f
1 changed files with 12 additions and 13 deletions
  1. 12
    13
      README.md

+ 12
- 13
README.md View File

@@ -37,13 +37,13 @@ then the benefits are different, but related.
37 37
   * Scaling is simply adding more IronFunctions nodes
38 38
 
39 39
 
40
-### System requirements
40
+## System requirements
41 41
 
42 42
 * Operating system: Linux/MacOS
43 43
 * Python version: 3.5 or greater
44 44
 * Database: MySQL 5.7 or greater
45 45
 
46
-### Quick-start guide
46
+## Quick-start guide
47 47
 
48 48
 * Install DevStack with [IronFunctions enabled](https://github.com/iron-io/picasso/blob/master/devstack/README.rst)
49 49
 * Clone the [Picasso source](https://github.com/iron-io/picasso)
@@ -53,7 +53,7 @@ Create a Python3.5 virtualenv
53 53
     $ virtualenv -p python3.5 .venv
54 54
     $ source .venv/bin/activate
55 55
 
56
-Install dependencies
56
+Install Picasso dependencies
57 57
 
58 58
     $ pip install -r requirements.txt -r test-requirements.txt
59 59
 
@@ -72,7 +72,7 @@ set the following environment variable:
72 72
 
73 73
     export PICASSO_MIGRATIONS_DB=mysql+pymysql://root:root@localhost/functions
74 74
 
75
-Use `alembic` to apply the migrations:
75
+Then use `alembic` to apply the migrations
76 76
 
77 77
     $ alembic upgrade head
78 78
 
@@ -103,22 +103,21 @@ The following are the minimum required options to start the Picasso API service:
103 103
 
104 104
 ### Building and Running Picasso in Docker
105 105
 
106
-From the Picasso repo, build a Docker image:
106
+Install [Docker engine](https://docs.docker.com/engine/installation/) if you haven't already.
107
+
108
+From the Picasso repo, build a Docker image using the following commands:
107 109
 
108 110
     export DOCKER_HOST=tcp://<docker-host>:<docker-port>
109 111
     docker build -t picasso-api -f Dockerfile .
110 112
 
111
-To start the container, pass in the required env vars, by
112
-
113
-`--env-file` example [Dockerfile.env](Dockerfile.env.example)
114
-
115
-     docker run -d -p 10001:10001 --env-file Dockerfile.env picasso-api
113
+To start the container, pass in the required env vars with `--env-file` or by entering all required
114
+values in `-e <KEY>=<VALUE>` format to the `docker run` command.
116 115
 
117
-or by entering all values in `-e <KEY>=<VALUE>` format.
116
+Example [Dockerfile.env](Dockerfile.env.example)
118 117
 
119
-Once the container is started, check if the service in running:
118
+    docker run -d -p 10001:10001 --env-file Dockerfile.env picasso-api
120 119
 
121
-In your web browser navigate to:
120
+Once the container is started, check if the service in running. In your web browser navigate to:
122 121
 
123 122
     <docker-host>:10001/api
124 123
 

Loading…
Cancel
Save