Skip to content

Commit

Permalink
✏️ doc: add configuration file and data directory description (#92)
Browse files Browse the repository at this point in the history
  • Loading branch information
Liquidwe authored Dec 12, 2024
1 parent 15ae2e8 commit b964627
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,9 @@ Here's an example of how to <b>process</b> 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/<name>`

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.
Expand Down

0 comments on commit b964627

Please sign in to comment.