From f76d213b6028e380b1accc807489e48bc8cef7f3 Mon Sep 17 00:00:00 2001 From: Resi Respati Date: Mon, 27 Nov 2017 19:28:27 +0700 Subject: [PATCH] [docs] fixing headings on 'Deploying' page --- docs/getting-started/deploying.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/deploying.md b/docs/getting-started/deploying.md index 53ad747..4f70415 100644 --- a/docs/getting-started/deploying.md +++ b/docs/getting-started/deploying.md @@ -1,6 +1,6 @@ # Deploying -## Building Configuration Files +## Building Your Configuration File The starter kit builds your code using `rollup`, which uses a `screeps.json` file as its configuration file. A sample config file is provided within the project, to use it, simply make a copy and rename it to `screeps.json`. @@ -49,16 +49,22 @@ The `screeps.json` file is a JSON configuration file that can be separated into } ``` +[/TODO: move to 'in-depth'] + We're going to focus on the `main` environment as a starter. Fill in your Screeps credentials accordingly, along with your target branch. > **Note:** You don't have to manually create the branch in your Screeps client if it doesn't exist yet. `rollup` will do it for you. +## Running Your First Deploy + Once you're done, run the following command: ```bash npm run push-main ``` -Now go to your Screeps client and make sure your code is deployed properly. +You're done! Now go to your Screeps client and make sure your code is deployed properly. ![deploying-1](img/deploying-1.png) + +Ready for something extra? Read on.