From 54b7bb9a5470d855ef05c51fb495243029eea91e Mon Sep 17 00:00:00 2001 From: Brian Seymour Date: Mon, 17 Jun 2019 00:09:35 -0500 Subject: [PATCH] Update readme.md --- readme.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/readme.md b/readme.md index 35f711c..46f32ae 100644 --- a/readme.md +++ b/readme.md @@ -69,6 +69,11 @@ cd ../tests - `lxc/execute [language] [file path] [arg]...` #### API Usage +To use the API, it must first be started. To start the API, run the following: +``` +cd api +./start +``` The Piston API exposes one endpoint at `http://127.0.0.1:2000/execute`. This endpoint takes the following JSON payload and expects at least the language and source. If source is not provided, a blank file is passed as the source.