add memory requirements (#888)

nttgin · Aug 24, 2022 · 9acc2f0 · 9acc2f0
1 parent c7ae35a
commit 9acc2f0
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,4 @@
+
 [![Build Status](https://github.com/nttgin/BGPalerter/workflows/Main/badge.svg)](https://github.com/nttgin/BGPalerter/actions?query=workflow%3AMain)
 [![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)
 
@@ -44,6 +45,7 @@ Read the documentation below for more options.
 ## Documentation
 
 - [Installation](docs/installation.md)
+    - [Requirements](docs/installation.md#requirements)
     - [Run from binary](docs/installation.md#running-bgpalerter-from-binaries)
     - [Run from source code](docs/installation.md#running-bgpalerter-from-the-source-code)
     - [Run in Docker](docs/installation.md#running-bgpalerter-in-docker)

diff --git a/docs/installation.md b/docs/installation.md
@@ -1,5 +1,8 @@
 # Installation
 
+## Requirements
+BGPalerter requires a machine with *minimum* 2GB RAM. However, I strongly recommend 4GB.
+
 ## Running BGPalerter from binaries - Quick Setup
 
 1. Download the binary [here](https://github.com/nttgin/BGPalerter/releases) (be sure to select the one for your OS)