From baf893dc610df26776b56893ce80a554a84adb2a Mon Sep 17 00:00:00 2001
From: Anton Iakimov <yakimant@gmail.com>
Date: Tue, 10 Oct 2023 16:47:38 +0200
Subject: [PATCH] readme: add node typed and CI info

---
 README.md | 27 +++++++++++----------------
 1 file changed, 11 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index 72b7b6f..0ec9966 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,17 @@
 # Description
 
-### :warning: Replace with actual description!
+This repo defines infrastructure for running [nim-waku](github.com/status-im/nim-waku) nodes shards.
 
->This repo defines a standard template for new Status infrastructure repositories.
->
->Key things to change:
->
->- Update `README.md`
->- Terraform
->    - Change `path` in `main.tf` to match new fleet
->    - Add necessary providers in `providers.tf`
->    - Add necessary secrets in `secrets.tf`
->    - Adjust or remove `workspaces.tf`
->    - Adjust `versions.tf`
->- Ansible
->    - Extend `ansible/group_vars/all.yml`
->    - Or add a dedicated `group_vars` file
->    - Create the `ansible/main.yml` playbook
+There are 2 kinds of nodes:
+
+* `node` - `nim-waku` nodes
+* `node-db` - PostgreSQL used by `node` nodes for envelope storage.
+
+# Continious Integration
+
+Jenkins CI builds can be used to build and deploy new Docker images:
+
+* `waku.test`: https://ci.infra.status.im/job/nim-waku/job/deploy-waku-test/
 
 # Repo Usage