Add README.md files to packages

Add README with basic descriptions of each package to all of the
packages in this repository.
This commit is contained in:
Hornwitser committed 2020-10-28 00:58:01 +01:00
1 parent 5fffc282fe
commit 4834c289ff
9 files changed
+745

No files matched your search

+16
View File
@@ -0,0 +1,16 @@
Clusterio Global Chat Plugin
============================
Plugin sharing the in-game chat between instances.
Installation
============
Run the following commands in the folder Clusterio is installed to:
npm install @clusterio/plugin-global_chat
npx clusteriomaster plugin add @clusterio/plugin-global_chat
Substitute clusteriomaster with clusterioslave or clusterioctl if this a
dedicate slave or ctl installation respectively.
+17
View File
@@ -0,0 +1,17 @@
Clusterio Research Sync Plugin
==============================
Plugin synchronizing research progress between instances and the
cluster.
Installation
============
Run the following commands in the folder Clusterio is installed to:
npm install @clusterio/plugin-research_sync
npx clusteriomaster plugin add @clusterio/plugin-research_sync
Substitute clusteriomaster with clusterioslave or clusterioctl if this a
dedicate slave or ctl installation respectively.
+18
View File
@@ -0,0 +1,18 @@
Clusterio Statistics Exporter Plugin
====================================
Plugin exporting item production, fluid production, kill count, entity
build and poluttion statistics to the Prometheus integration to
Clusterio.
Installation
============
Run the following commands in the folder Clusterio is installed to:
npm install @clusterio/plugin-statistics_exporter
npx clusteriomaster plugin add @clusterio/plugin-statistics_exporter
Substitute clusteriomaster with clusterioslave or clusterioctl if this a
dedicate slave or ctl installation respectively.
+16
View File
@@ -0,0 +1,16 @@
Clusterio Subspace Storage Plugin
=================================
Plugin for the Subpsace Storage mod.
Installation
============
Run the following commands in the folder Clusterio is installed to:
npm install @clusterio/plugin-subspace_storage
npx clusteriomaster plugin add @clusterio/plugin-subspace_storage
Substitute clusteriomaster with clusterioslave or clusterioctl if this a
dedicate slave or ctl installation respectively.