From 0a0e08c2666ad86732f16ccbb45e85b6286c3696 Mon Sep 17 00:00:00 2001 From: Dima Pristupa Date: Wed, 8 May 2024 19:33:18 +0300 Subject: [PATCH] README.md: add the Preparation section --- README.md | 14 +++++++++++++- package-lock.json | 4 ++-- 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ad5134a..cdcffbc 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,19 @@ If you are new to Open Data Fabric and Kamu - please [start here](https://docs.k ## Getting Started -TBD +### Preparation + +For building contracts, we use [Foundry](https://github.com/foundry-rs/foundry). To install, please use [the official documentation](https://book.getfoundry.sh/getting-started/installation). + +https://book.getfoundry.sh/getting-started/installation + +--- + +After that, we can start building the contacts: + +```shell +npm run build +``` ## Community diff --git a/package-lock.json b/package-lock.json index b3908f8..3c920d2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { - "name": "@opendatafabric/oracle", + "name": "@opendatafabric/contracts", "version": "1.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "@opendatafabric/oracle", + "name": "@opendatafabric/contracts", "version": "1.0.0", "dependencies": { "@openzeppelin/contracts": "^5.0.1",