From b964627a2e3c7f0bed6ead9c61ffb5d03f6f0d5c Mon Sep 17 00:00:00 2001
From: Liquid <116100070+Liquidwe@users.noreply.github.com>
Date: Thu, 12 Dec 2024 19:26:28 +0800
Subject: [PATCH] =?UTF-8?q?=E2=9C=8F=EF=B8=8F=20doc:=20add=20configuration?=
=?UTF-8?q?=20file=20and=20data=20directory=20description=20(#92)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README.md | 3 +++
1 file changed, 3 insertions(+)
diff --git a/README.md b/README.md
index ddce4e5..afa73bc 100644
--- a/README.md
+++ b/README.md
@@ -90,6 +90,9 @@ Here's an example of how to process data from chainbase with manuscript:
😆😆 data has never been so simple...
### Key Concepts
+Default location for the Manuscript configuration file: `~/.manuscript_config.ini`
+For local setups, data storage directory: `~/manuscripts/`
+
There are two primary objects:
- `manuscript.yaml` - A script file used to describe the data processing workflow, defining data sources, data processing methods, and the final data flow direction.
- `docker-compose.yaml` - The Docker Compose file defines a local container cluster environment, allowing developers to test locally. After testing, it can be deployed to the Chainbase distributed network.