From 2e50921d32038fac5de6057b376f4102aacd6fd7 Mon Sep 17 00:00:00 2001 From: Arvids Godjuks Date: Thu, 5 Sep 2019 14:55:42 +0200 Subject: [PATCH] Documentation adjustments (#225) README.md update - adjusted install instruction to be against the stable branch --- README.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 79d383b7..34add421 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,6 @@

-# Warning - -Do not use master branch to run your Clusterio - master now is a development version and may not work - -Use latest stable release: https://github.com/clusterio/factorioClusterio/releases/latest - -Or clone latest stable branch that has name format `x.y.z` - # factorioClusterio Discord for development/support/play: https://discord.gg/5XuDkje @@ -19,9 +11,13 @@ Discord for development/support/play: https://discord.gg/5XuDkje ## Important notice This is the development branch for factorioClusterio 2.0 which is currently undergoing heavy -restructuring and refactoring. Expect plugins and existing installations to frequenltly break when +restructuring and refactoring. Expect plugins and existing installations to frequently break when using this branch. If you don't want to be an alpha tester for 2.0 please use the stable -[1.2.x branch](https://github.com/clusterio/factorioClusterio/tree/1.2.x). +[1.2.x branch](https://github.com/clusterio/factorioClusterio/tree/1.2.x) or +[latest stable release](https://github.com/clusterio/factorioClusterio/releases/latest). + +Installation instructions below are for stable release - if you need a development version - +just drop `-b 1.2.x` from clone command and `--only=production` from the `npm install` command. ### Ways to support me/the project: